diff --git a/docs/tutorials.md b/docs/tutorials.md index cf5d58a5d67e1a4daf7b412209c0821bd613ab1d..8f401f895b58c1e3febcf985716d7de00928536c 100644 --- a/docs/tutorials.md +++ b/docs/tutorials.md @@ -2,4 +2,5 @@ Various integrations developed using IICS. * [WiscAlerts Integrations](./tutorials/wiscalerts/wiscalerts.md) -* [Using Box Connector For Flat Files](./tutorials/box/box.md) \ No newline at end of file +* [Using Box Connector For Flat Files](./tutorials/box/box.md) +* [Person API in CDI](./tutorials/PersonAPI/PersonAPIwRESTv2.md) diff --git a/docs/tutorials/PersonAPI/PersonAPIwRESTv2.md b/docs/tutorials/PersonAPI/PersonAPIwRESTv2.md index 11d474b0082d76f16603fa5f5e6000628e076754..3c293f585d1e23c81f2d42a46fb4d9ccb7d27ffc 100644 --- a/docs/tutorials/PersonAPI/PersonAPIwRESTv2.md +++ b/docs/tutorials/PersonAPI/PersonAPIwRESTv2.md @@ -1,3 +1,14 @@ +### 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. ### Prerequisites @@ -25,7 +36,7 @@ This tutorial demonstrates how to create a connection within Informatica Intelli  -8. In the _Type_ drop menu: +8. In the _Type_ dropdown menu: - Create a _Connection Name_ - Select _REST V2 (Informatica Cloud)_ - Select your _Runtime Environment_ @@ -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. 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. @@ -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. 3. Select _Swagger Files_ on the left pane. 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. -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. -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. Upload this response file in the _Json Response File_ field. +8. Obtain a response file from PersonAPI for the operation you have selected. This can easily be done using [Postman](https://www.postman.com/). +9. Upload this response file in the _Json Response File_ field.  +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. + + + ### 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. diff --git a/docs/tutorials/PersonAPI/images/SwaggerDone.png b/docs/tutorials/PersonAPI/images/SwaggerDone.png new file mode 100644 index 0000000000000000000000000000000000000000..4bca78535a2ed4ee319d08561179356621c7b83c Binary files /dev/null and b/docs/tutorials/PersonAPI/images/SwaggerDone.png differ