Accessing the API

Our API Documentation can be accessed at https://ipaas.com/developer-tools.

We have different root URLs for our different environments:

NOTE: Not all users will have accounts on both environments. The links in this documentation link to the Production Swagger pages, but the root URL can be changed as needed to access staging documentation and to interact with that API.

Navigate to the SSO API. Expand the /v2/Auth/Login API. Click on Try it out:

Enter your iPaaS.com username and password (between the quotes) and click on execute. The permissions in the API match the permissions you have in the iPaaS.com UI.

If the call is successful you will see a response that looks like this:

Copy and paste the access_token (without the quotes) into the popup you see after clicking on the authorize button at the top of the screen and then click authorize and then close.

If successful that lock will show as closed like this:

NOTE: Tokens expire after 1 hour.

In order to access data from a specific company you will need to get a list of companies you are tied to and then generate a company-specific token to be used with other APIs.

Scroll down to the User section and open the GET /v2/User/{id}/Companies endpoint and click on the try it out button. In the User Id field enter the user ID from auth results above. Click Execute.

You will get a result that looks like this (but may only have one company):

Copy the ID from the company you want to use.

Scroll down to GET /v2/User/ChangeCompany/{id}. Click Try it out and paste the ID from the previous step into the Id of the Company field. Click Execute and you will see an output that looks like this:

You will then use that access token to authenticate with other APIs as that company.