Overview
This guide covers how to authenticate with the iPaaS API and switch between companies.
Important:If you aren't familiar with working with an API and Swagger, you can experience the following issues:
Proceed with caution and ensure you have the necessary skills and understanding before interacting with this system. |
API Documentation
Access our API documentation at https://ipaas.com/developer-tools.
Environment URLs
Environment | URL | API Root URL | Swagger Root URL |
Production | portal.ipaas.com/ | api.ipaas.com | api.ipaas.com |
Staging | staging.ipaas.com/ | stagingapi.ipaas.com | stagingapi.ipaas.com |
NOTE: Not all users have accounts on both environments. This documentation links to Production Swagger pages, but you can change the root URL to access staging documentation and interact with that API. |
Authenticating with your Username and Password
Step 1: Access the Login API
Navigate to the SSO API (A).
If not already expanded, click POST
/v2/Auth/Login API(B) .Click Try it out (C).
NOTE: Ensure the Servers dropdown is set to |
Step 2: Enter Credentials
Under Request body, enter your iPaaS.com email address and password. Do not remove the quotes. For example
"email_address: "roger.stirling@example.com"
and
"password: "Password4816$".Click Execute.
Your API permissions match your iPaaS.com UI permissions.
Step 3: Copy the Access Token
If successful, you'll receive a response containing an access_token. Copy this token (without quotes).
Step 4: Authorize Your Session
Click Authorize at the top of the Swagger interface.
Find the access token in the Responses section. It is under Server response. The Code should be 200. If you receive another code, such as 400 Bad request or 401 Unauthorized, check your email address and password and try again.
Paste the access token into the Available authorizations dialog box.
Click Authorize, then Close.
When successful, the lock icon appears closed, indicating you're authenticated.
Important: Tokens expire after 1 hour. |
Working with Multiple Companies
To access data for a specific company, you need to:
Get a list of companies you're associated with.
Generate a company-specific access token.
Get Your Company List
To get your company list:
Navigate to the User section.
Open the
GET /v2/User/{id}/Companiesendpoint.
Click Try it out.
Enter your User ID from the authentication response.
Click Execute.
The response will show all companies associated with your account. Copy the ID of the company you want to work with.
Get a Company-Specific Access Token
To get your company token:
Navigate to
GET /v2/User/ChangeCompany/{id}.Click Try it out.
Paste the company ID into the Id of the Company field.
Click Execute.
Use the returned access token to authenticate with other APIs for that specific company.
Quick Reference
Token Expiration: 1 hour
Server Setting: Must be set to
/ssofor authenticationPermissions: API permissions match your iPaaS.com UI permissions
Company Switching: Required for multi-company access