Guidance: the primary use case for using this API is to automate provisioning and de-provisioning of your SmartConnector product (i.e. based on your website sign ups, or web store purcahses, or a subscription management platform). For example, you might want to allow users to register on your website for a free trial, and then when they click submit then your server backend would use the API below to creates a 30 day trial license. Or, if you are using a formal subscription management platform, and a user's subscription ends, or a user does not submit a payment on time, then you can use the API below to automatically expire their license (thus shutting off their integration).
| Relative URI | Method | Success Code | Description |
|---|---|---|---|
| /connectors | GET | 200 | Get all connectors. |
| /connectors/{_id} | GET | 200 | Get a specific connector. |
| /connectors | POST | 201 | Create a new connector. |
| /connectors/{_id} | PUT | 200 | Update a specific connector. |
| /connectors/{_id} | DELETE | 204 | Delete a specific connector. |
| /connectors/{_id}/installBase | GET | 200 | Get the install base for a specific connector. |
| /connectors/{_id}/update | PUT | 200 | Push update to _integrationIds[]. |
| /connectors/{_id}/licenses | GET | 200 | Get all licenses for a specific connector. |
| /connectors/{_id}/licenses | POST | 201 | Create new license for a specific connector. |
| /connectors/{_id}/licenses/{_id_of_license} | GET | 200 | Get a specific license. |
| /connectors/{_id}/licenses/{_id_of_license} | PUT | 200 | Update a specific license. |
| /connectors/{_id}/licenses/{_id_of_license} | DELETE | 204 | Delete a specific license. |
GET /v1/connectors/54fa0b38a7044f9252000036 HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
Sample Response:
{
"_id": "123ab456c789de1011fg12h13i",
"name": "Shopify - NetSuite Connector",
"description": "Shopify - NetSuite Connector helps retailers combine the powerful Shopify eCommerce platform with the proven back-office features of NetSuite and keep the orders, customers, fulfillments, billings, items & inventory levels in sync.",
"imageURL": "/images/company-logos/shopify-netsuite.png",
"websiteURL": "http://www.celigo.com/products/netsuite-shopify-connector/",
"contactEmail": "[email protected]",
"handle": "sc4n",
"published": true,
"managed": true,
"_integrationId": "123ab456c789de1011fg12acab",
"_stackId": "5593228187085d362c0444a455",
"installerFunction": "installConnector",
"updateFunction": "updateConnector",
"preUninstallFunction": "preUninstallFunction",
"uninstallerFunction": "uninstallConnector",
"externalInstallerFunction": "installConnectorFromExternalApp",
"lastModified": "2017-09-12T11:47:25.957Z",
"_sharedImportIds": [],
"_sharedExportIds": [],
"_iClientIdMap": [
{
"_id": false,
"_iClientIds": [
"123f9dfc4a7d2ca3238e19c123"
],
"connection": {
"type": "netsuite"
}
}
],
"applications": [
"netsuite",
"shopify"
],
"oAuthServerFlow": {
"_iClientId": "123fa0c93a7044f9252000123"
}
}
GET /v1/connectors/54fa0b38a7044f9252000036/licenses HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
Sample Response:
[
{
"_id": "123ab456c789de1011fg12h13i",
"expires": "2018-11-16T18:29:59.999Z",
"created": "2017-10-24T09:10:59.408Z",
"opts": {
"addonLicenses": [
{
"licenses": [
{
"addOnEdition": "standard"
}
],
"type": "store"
}
],
"connectorEdition": "standard"
},
"user": {
"email": "[email protected]",
"_id": "123ab456c789de1011fg12h13i",
"name": "Sathvika Dogiparthi"
},
"_integrationId": "123ab456c789de1011fg12acab"
},
{
"_id": "123ab456c789de1011fg12h13i",
"expires": "2025-07-01T00:00:00.000Z",
"created": "2017-10-10T05:01:14.178Z",
"opts": {
"addonLicenses": [
{
"licenses": [
{
"addOnEdition": "enterprise"
}
],
"type": "store"
}
],
"connectorEdition": "enterprise"
},
"user": {
"email": "[email protected]"
}
}
]
Important: the API to create a new license (vs update an existing license) is somewhat unique in that you need to supply the email address of the integrator.io user in the post body, and then the integrator.io backend will use the email to dynamically find the correct user. Assuming the email is a valid user, you will see a read-only "user" property in the response, and then once the user clicks the install button from within their integrator.io account you will then see their "_id" and "name" values as well if you do another GET on the license resource (or just view it in your integrator.io account UI).
POST /v1/connectors/54fa0b38a7044f9252000036/licenses HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
{
"email": "[email protected]",
"expires": "2017-11-01T18:29:59.999Z",
"opts": {
"addonLicenses": [
{
"licenses": [
{
"addOnEdition": "standard"
}
],
"type": "store"
}
],
"connectorEdition": "standard"
}
}
Sample Response:
{
"_id": "123ab456c789de1011fg12h13i",
"expires": "2017-11-01T18:29:59.999Z",
"created": "2017-10-24T16:22:11.448Z",
"opts": {
"connectorEdition": "standard",
"addonLicenses": [
{
"type": "store",
"licenses": [
{
"addOnEdition": "standard"
}
]
}
]
},
"user": {
"email": "[email protected]"
}
}
4. Update the license created above to change the expires date and also provision the enterprise version of the connector.
Small note: unlike the API to create new licenses (detailed above), you do NOT need to send "email" to update existing license records.
PUT /v1/connectors/54fa0b38a7044f9252000036/licenses/59ef68b384b38c7986d54549 HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
{
"expires": "2020-11-01T18:29:59.999Z",
"opts": {
"addonLicenses": [
{
"licenses": [
{
"addOnEdition": "enterprise"
}
],
"type": "store"
}
],
"connectorEdition": "enterprise"
}
}
Sample Response:
{
"_id": "123ab456c789de1011fg12h13i",
"expires": "2020-11-01T18:29:59.999Z",
"created": "2017-10-24T16:22:11.448Z",
"opts": {
"connectorEdition": "enterprise",
"addonLicenses": [
{
"type": "store",
"licenses": [
{
"addOnEdition": "enterprise"
}
]
}
]
},
"user": {
"email": "[email protected]",
"_id": "123ab456c789de1011fg12h13i",
"name": "Celigo Tester"
},
"_integrationId": "123ab456c789de1011fg12acab"
}
POST /v1/connectors/54fa0b38a7044f9252000036/licenses HTTP/1.1
Host: api.integrator.io
Authorization: Bearer my_api_token
{
"email": "[email protected]",
"expires": "2017-11-01T18:29:59.999Z",
"opts": {
"addonLicenses": [
{
"licenses": [
{
"addOnEdition": "standard"
}
],
"type": "store"
}
],
"connectorEdition": "standard"
}
}
Sample Response:
{
"errors": [
{
"code": "invalid_user",
"message": "We were not able to find any user with the provided email address. Please ask the user to first create an integrator.io account."
}
]
}