Skip to content
Snippets Groups Projects
Commit 73513118 authored by SAM CARPENTER's avatar SAM CARPENTER
Browse files

Update docs/tutorials/PersonAPI/PersonAPIwRESTv2.md,...

Update docs/tutorials/PersonAPI/PersonAPIwRESTv2.md, docs/tutorials/PersonAPI/images/SwaggerDone.png, docs/tutorials.md
parent f8f8a979
No related branches found
No related tags found
1 merge request!45External Doc Reorganization
...@@ -2,4 +2,5 @@ ...@@ -2,4 +2,5 @@
Various integrations developed using IICS. Various integrations developed using IICS.
* [WiscAlerts Integrations](./tutorials/wiscalerts/wiscalerts.md) * [WiscAlerts Integrations](./tutorials/wiscalerts/wiscalerts.md)
* [Using Box Connector For Flat Files](./tutorials/box/box.md) * [Using Box Connector For Flat Files](./tutorials/box/box.md)
\ No newline at end of file * [Person API in CDI](./tutorials/PersonAPI/PersonAPIwRESTv2.md)
### Contents
- [Introduction](#introduction)
- [Prerequesites](#prerequisites)
- [Connections](#connections)
- [Usage as Source in Mappings](#usage-as-source-in-mappings)
- [Creating Your Own Swagger Files](#creating-your-own-swagger-files)
- [Important Notes](#important-notes)
### Introduction
This tutorial demonstrates how to create a connection within Informatica Intelligent Cloud Services Cloud Data Integration (IICS CDI) using the RESTv2 connector to connect to the [Mock Person API](https://developer.wisc.edu/docs/mock-person-api/1/overview). In production, you will want to use the non-Mock [Person API](https://developer.wisc.edu/docs/person-api/1/overview). Instructions for requesting access to it are located [Here](https://developer.wisc.edu/person-api/getting-access) if you don't have access already. This tutorial demonstrates how to create a connection within Informatica Intelligent Cloud Services Cloud Data Integration (IICS CDI) using the RESTv2 connector to connect to the [Mock Person API](https://developer.wisc.edu/docs/mock-person-api/1/overview). In production, you will want to use the non-Mock [Person API](https://developer.wisc.edu/docs/person-api/1/overview). Instructions for requesting access to it are located [Here](https://developer.wisc.edu/person-api/getting-access) if you don't have access already.
### Prerequisites ### Prerequisites
...@@ -25,7 +36,7 @@ This tutorial demonstrates how to create a connection within Informatica Intelli ...@@ -25,7 +36,7 @@ This tutorial demonstrates how to create a connection within Informatica Intelli
![IICS Administrator](images/administrator.png "IICS Administrator") ![IICS Administrator](images/administrator.png "IICS Administrator")
8. In the _Type_ drop menu: 8. In the _Type_ dropdown menu:
- Create a _Connection Name_ - Create a _Connection Name_
- Select _REST V2 (Informatica Cloud)_ - Select _REST V2 (Informatica Cloud)_
- Select your _Runtime Environment_ - Select your _Runtime Environment_
...@@ -40,7 +51,7 @@ This tutorial demonstrates how to create a connection within Informatica Intelli ...@@ -40,7 +51,7 @@ This tutorial demonstrates how to create a connection within Informatica Intelli
9. Press the _Test Connection_ button in the upper right of the window to verify the connection is successful. 9. Press the _Test Connection_ button in the upper right of the window to verify the connection is successful.
10. If the connection is successful, press the _Save_ button. 10. If the connection is successful, press the _Save_ button.
### Usage as a Source in a Mapping ### Usage as Source in Mappings
1. To use PersonAPI as a source in a mapping, select the connection you just created as the source. To get a list of all people, select _get people_ as the operation. 1. To use PersonAPI as a source in a mapping, select the connection you just created as the source. To get a list of all people, select _get people_ as the operation.
...@@ -70,15 +81,26 @@ To perform different operations, you will need to create and host your own Swagg ...@@ -70,15 +81,26 @@ To perform different operations, you will need to create and host your own Swagg
2. Chose the _Administrator_ tile in the My Services window. 2. Chose the _Administrator_ tile in the My Services window.
3. Select _Swagger Files_ on the left pane. 3. Select _Swagger Files_ on the left pane.
4. Select the _New_ button in the upper right of the window. 4. Select the _New_ button in the upper right of the window.
5. Set the _URL_ as https<area>://mock.api.wisc.edu and the _API Path_ as /people. Leave the _API Base Path_ blank. 5. Set the _Runtime Enviornment_ of your Swagger File.
6. Set the _URL_ as https<area>://mock.api.wisc.edu and the _API Path_ as /people. Leave the _API Base Path_ blank.
- Note that while there is authentication for the API, you can leave the _Authentication_ as blank in the swagger file, as authorizing requests is handled on the connector level. - Note that while there is authentication for the API, you can leave the _Authentication_ as blank in the swagger file, as authorizing requests is handled on the connector level.
6. Set the _Operation ID_ to the name of the operation you want to use. This can be found in the API spec. 7. Set the _Operation ID_ to the name of the operation you want to use. This can be found in the API spec.
- Also set the _Verb_ to the one matching the operation. For operations which involve recieving data, this will usually be GET. - Also set the _Verb_ to the one matching the operation. For operations which involve recieving data, this will usually be GET.
7. Obtain a response file from PersonAPI for the operation you have selected. This can easily be done using [Postman](https://www.postman.com/). 8. Obtain a response file from PersonAPI for the operation you have selected. This can easily be done using [Postman](https://www.postman.com/).
8. Upload this response file in the _Json Response File_ field. 9. Upload this response file in the _Json Response File_ field.
![Swagger File Creation](images/SwaggerCreation.png "Swagger File Creation") ![Swagger File Creation](images/SwaggerCreation.png "Swagger File Creation")
10. Save your Swagger file. Once you have saved it you can no longer edit it, and must repeat the process from step 5 to make any changes.
11. Navigate back to _Swagger Files_ on the left pane.
12. Locate the Swagger File you just created in the list below.
13. Press the Download button to download the file to your personal computer.
14. Host the file somewhere that can be publically accessed, such as a public Gitlab repository.
Once this process is complete, you will be able to use the link to your Swagger file in the _Swagger File Path_ section of the RESTv2 Connector.
![Swagger File Download](images/SwaggerCreation.png "Swagger File Download")
### Important Notes ### Important Notes
- The RESTv2 Connector does not accept swagger files of the OpenAPI3.0 specification (which PersonAPI uses), so the Swagger files must be created using the IICS tool. - The RESTv2 Connector does not accept swagger files of the OpenAPI3.0 specification (which PersonAPI uses), so the Swagger files must be created using the IICS tool.
......
docs/tutorials/PersonAPI/images/SwaggerDone.png

33.4 KiB

0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment