Download integrator.io Postman collection
iClient API endpoints
Relative URI | Method | Success Code | Description |
/iclients | GET | 200 | Get all iClients. |
/iclients/<_id> | GET | 200 | Get a specific iClient. |
/iclients | POST | 201 | Create a new iClient. |
/iclients/<_id> | PUT | 200 | Update a specific iClient. |
/iclients/<_id> | DELETE | 204 | Delete a specific iClient. |
iClient API examples
GET /v1/iclients HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
Sample Response:
[ { "_id":"58c40879c13f547763bf2ffe", "name":"Amazon - North America", "lastModified":"2017-03-15T10:07:54.070Z", "provider":"amazonmws", "amazonmws":{ "accessKeyId":"abcdef12345", "secretKey":"******" } }, { "_id":"58d91651a81cfe09ec94a996", "name":"eBay Sandbox", "lastModified":"2017-04-12T07:50:56.863Z", "provider":"ebay-xml", "ebay":{ "appId":"Celigo-XXXX", "devId":"abcdef12345", "certId":"******", "ruName":"Celigo-ABC" } }, { "_id":"58d95676544a250f82e1e6a8", "name":"eBay", "lastModified":"2017-04-12T07:51:17.839Z", "provider":"ebay-xml", "ebay":{ "appId":"Celigo-YYYY", "devId":"zyxwvu12345", "certId":"******", "ruName":"Celigo-XYZ" } }, { "_id":"58f9dfc4a7d2ca9998e19c89", "name":"NetSuite", "lastModified":"2017-04-21T10:32:37.100Z", "provider":"netsuite", "netsuite":{ "consumerKey":"******", "consumerSecret":"******" } }, { "_id":"54fa0c93a7044f9252483038", "lastModified":"2015-12-09T11:17:23.235Z", "provider":"Shopify", "oauth2":{ "clientId":"c12345", "clientSecret":"******", "scope":[ "read_products", "write_products", "read_customers", "read_orders", "write_orders" ], "scopeDelimiter":"," } } ]
The following examples cover creating an iClient in Postman.
Create an HTTP iClient via Postman
- Create an OAuth application in your source or destination account.
- Copy the client Id and client secret.
- Navigate to Postman.
- Create a new request.
- Method: POST
- URL: https://api.integrator.io/v1/iclients
- Body:
{ "name": "<<iClient NAME>>", "provider": "custom_oauth2", "oauth2": { "clientId": "<<APPLICATION CLIENT ID>>", "clientSecret": "<<APPLICATION CLIENT SECRET>>", "scope": ["<<scope1>>","<<scope>>"], "scopeDelimiter" : "<<scopeDelimeter>>" } }
- Scope: “OAuth” and “Contacts”
- Scope delimiter: A space <“ “>
- Authorization: Bearer <<Add IO token here>>

Create a NetSuite iClient
- Create an integration record in NetSuite.
- Copy your client ID and client secret.
- Navigate to Postman.
- Create a new request.
- Method: POST
- URL: https://api.integrator.io/v1/iClients
- Body:
{ "provider": "netsuite", "netsuite": { "consumerKey": "enter consumer key", "consumerSecret": "enter consumer secret" } }
Attach iClients to an integration app
- Get the integration application via Postman.
- Method: GET
- URL: https://api.integrator.io/v1/connectors/{{integrationAppid}}
- Copy the response.
- Add the iClientIdMap node to the copied body:
"_iClientIdMap": [ { "_iClientIds": [ "Enter newly created iClientId" ], "connection": { "type": "http" } }, { "_iClientIds": [ "Enter netsuite iClientId" ], "connection": { "type": "netsuite" } } ],
- Save the integration application.
- Method: GET
- URL: https://api.integrator.io/v1/connectors/{{integrationAppid}}
- Copy the response.
- Add the iClientIdMap node to the copied body:
"_iClientIdMap": [ { "_iClientIds": [ "Enter newly created iClientId" ], "connection": { "type": "http" } }, { "_iClientIds": [ "Enter netsuite iClientId" ], "connection": { "type": "netsuite" } } ],
- Save the integration application.
- Method: PUT
- URL: https://api.integrator.io/v1/connectors/{{integrationAppid}}
Comments
0 comments
Please sign in to leave a comment.