Articles in this section

Connector and License API endpoints

download.svg​​ Download Postman collection

These endpoints are only available to Celigo Partners.

GET /v1/connectors – Get all connectors

Get all connectors.

Method

GET

Relative URI

/v1/connectors

Response body structure

{
  "_id": "54f••••••036",
  "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": "sales@celigo.com",
  "handle": "sc4n",
  "published": true,
  "managed": true,
  "_integrationId": "551c••••••••00c",
  "_stackId": "559••••••••09",
  "installerFunction": "installConnector",
  "updateFunction": "updateConnector",
  "preUninstallFunction": "preUninstallFunction",
  "uninstallerFunction": "uninstallConnector",
  "externalInstallerFunction": "installConnectorFromExternalApp",
  "lastModified": "2017-09-12T11:47:25.957Z",
  "_sharedImportIds": [],
  "_sharedExportIds": [],
  "_iClientIdMap": [
    {
      "_id": false,
      "_iClientIds": [
        "58f•••••••••c89"
      ],
      "connection": {
        "type": "netsuite"
      }
    }
  ],
  "applications": [
    "netsuite",
    "shopify"
  ],
  "oAuthServerFlow": {
    "_iClientId": "54f••••••••038"
  }
}

POST /v1/connectors – Create a new connector

Create a new connector.

Method

POST

Relative URI

/v1/connectors

GET /v1/connectors/:_id – Get a specific connector

Get a specific connector.

Method

GET

Relative URI

/v1/connectors/:_id

Response body structure

{
  "_id": "54f••••••036",
  "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": "sales@celigo.com",
  "handle": "sc4n",
  "published": true,
  "managed": true,
  "_integrationId": "551••••••••00c",
  "_stackId": "559•••••••••009",
  "installerFunction": "installConnector",
  "updateFunction": "updateConnector",
  "preUninstallFunction": "preUninstallFunction",
  "uninstallerFunction": "uninstallConnector",
  "externalInstallerFunction": "installConnectorFromExternalApp",
  "lastModified": "2017-09-12T11:47:25.957Z",
  "_sharedImportIds": [],
  "_sharedExportIds": [],
  "_iClientIdMap": [
    {
      "_id": false,
      "_iClientIds": [
        "58f•••••••••••••c89"
      ],
      "connection": {
        "type": "netsuite"
      }
    }
  ],
  "applications": [
    "netsuite",
    "shopify"
  ],
  "oAuthServerFlow": {
    "_iClientId": "54f••••••••••038"
  }
} 

PUT /v1/connectors/:_id – Update a specific connector

Update a specific connector.

Method

PUT

Relative URI

/v1/connectors/:_id

DELETE /v1/connectors/:_id – Delete a specific connector

Delete a specific connector.

Method

DELETE

Relative URI

/v1/connectors/:_id

GET /v1/connectors/:_id/installBase – Get the install base for a specific connector

Get the install base for a specific connector.

Method

GET

Relative URI

/v1/connectors/:_id/installBase

PUT /v1/connectors/:_id/update – Push update to _integrationIds[]

Push update to _integrationIds[].

Method

PUT

Relative URI

/v1/connectors/:_id/update

GET /v1/connectors/:_id/licenses – Get all licenses for a specific connector

Get all licenses for a specific connector.

Method

GET

Relative URI

/v1/connectors/:_id/licenses

Response body structure

[
  {
    "_id": "59e•••••••••••667",
    "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": "Jane.Doe@celigo.com",
      "_id": "585•••••••••5ed",
      "name": "John Doe"
    },
    "_integrationId": "59e•••••••••••••••4d5"
  },
  {
    "_id": "59d•••••••••••••220",
    "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": "John.Doe@celigo.com"
    }
  }
] 

POST /v1/connectors/:_id/licenses – Create a new license for a specific connector

Create a new license for a specific connector.

Important

The API to create a new license (versus update an existing license) is 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).

Method

POST

Relative URI

/v1/connectors/:_id/licenses

Request body structure

Create a license.

{
  "email": "test@domain.com",
  "expires": "2017-11-01T18:29:59.999Z",
  "opts": {
    "addonLicenses": [
      {
        "licenses": [
          {
            "addOnEdition": "standard"
          }
        ],
        "type": "store"
      }
    ],
    "connectorEdition": "standard"
  }
} 

Create a license for someone who has not signed up for the Celigo platform yet.

{
  "email": "does_not_exist@domain.com",
  "expires": "2017-11-01T18:29:59.999Z",
  "opts": {
    "addonLicenses": [
      {
        "licenses": [
          {
            "addOnEdition": "standard"
          }
        ],
        "type": "store"
      }
    ],
    "connectorEdition": "standard"
  }
}

Response body structure

Create a license.

{
  "_id": "59e•••••••549",
  "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": "test@domain.com"
  }
}

Create a license for someone who has not signed up for the Celigo platform yet.

{
  "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."
    }
  ]
}

GET /v1/connectors/:_id/licenses/:_licenseId– Get a specific license

Get a specific license.

Method

GET

Relative URI

/v1/connectors/:_id/licenses/:_licenseId

Response body structure

{
  "_id": "59e••••••••••549",
  "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": "test@domain.com",
    "_id": "585••••••••••5ff",
    "name": "Celigo Tester"
  },
  "_integrationId": "59e•••••••••••••4ee"
}

PUT /v1/connectors/:_id/licenses/:_licenseId – Update a specific license

Update a specific license.

Note

Unlike the API for creating new licenses (detailed above), you do not need to send an "email" to update existing license records.

Method

PUT

Relative URI

/v1/connectors/:_id/licenses/:_licenseId

Request body structure

Update the license created above to change the expiration date and also provision the enterprise version of the connector

{
  "expires": "2020-11-01T18:29:59.999Z",
  "opts": {
    "addonLicenses": [
      {
        "licenses": [
          {
            "addOnEdition": "enterprise"
          }
        ],
        "type": "store"
      }
    ],
    "connectorEdition": "enterprise"
  }
} 

Response body structure

{
  "_id": "59e••••••••••549",
  "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": "test@domain.com",
    "_id": "585••••••••••5ff",
    "name": "Celigo Tester"
  },
  "_integrationId": "59e•••••••••••••4ee"
}

DELETE /v1/connectors/:_id/licenses/:_licenseId – Delete a specific license

Delete a specific license.

Method

DELETE

Relative URI

/v1/connectors/:_id/licenses/:_licenseId