Recurly Authenticate an Element Instance

You can authenticate with Recurly to create your own instance of the Recurly element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the Recurly platform.

Authenticate Through the UI

Use the UI to authenticate with Recurly and create an element instance as described in Authenticate an Element Instance (UI). You will need the subdomain and Recurly API key values that you identified in Recurly API Provider Setup.

After successfully authenticating, we give you several options for next steps. Make requests using the API docs associated with the instance, map the instance to a virtual data resource, or use it in a formula template.

Authenticate Through API

Send a request to our /instances endpoint to authenticate an element instance. When finished note the token and id.

To authenticate an element instance:

1. Construct a JSON body as shown below (see Parameters):

   {
     "element": {
       "key": "recurly"
     },
     "configuration": {
       "subdomain": "<INSERT_SUBDOMAIN>",
       "ApiVersion": "<INSERT_APIVERSION>",
       "recurly.api.key": "<INSERT_RECURLY_API_KEY>"
     },
     "tags": [
       "<ADD_YOUR_TAGS>"
     ],
     "name": "<INSTANCE_NAME>"
   }

2. Call the following, including the JSON body you constructed in the previous step:

   POST /instances

   Note: Make sure that you include the User and Organization keys in the header. See the Overview for details.

3. Locate the token and id in the response and save them for all future requests using the element instance.

Example cURL

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2/instances \
  -H 'authorization: User <USER_SECRET>, Organization <ORGANIZATION_SECRET>' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "recurly"
  },
  "configuration": {
    "subdomain": "<INSERT_SUBDOMAIN>",
    "ApiVersion": "<INSERT_APIVERSION>",
    "recurly.api.key": "<INSERT_RECURLY_API_KEY>"
  },
  "tags": [
    "<ADD_YOUR_TAGS>"
  ],
  "name": "<INSTANCE_NAME>"
}

Parameters

API parameters not shown in Cloud Elements 2.0 are in code formatting.

Example Response for an Authenticated Element Instance

In this example, the instance ID is 12345 and the instance token starts with "ABC/D...". The actual values returned to you will be unique: make sure you save them for future requests to this new instance.

{
  "id": 12345,
  "name": "My Cool Instance",
  "createdDate": "2019-10-17T22:31:01Z",
  "token": "ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx=",
  "elementId": 3128,
  "tags": [
    "My Cool Instance"
  ],
  "provisionInteractions": [],
  "valid": true,
  "disabled": false,
  "maxCacheSize": 0,
  "cacheTimeToLive": 0,
  "configuration": {},
  "authenticationType": "custom",
  "eventsEnabled": false,
  "cachingEnabled": false,
  "externalAuthentication": "none",
  "traceLoggingEnabled": false,
  "organizationId": 12345,
  "accountId": 123456,
  "userId": 123456,
  "element": {
    "id": 3128,
    "name": "Recurly",
    "key": "recurly",
    "description": "Add a Recurly Instance to connect your existing Recurly account to the Billing Hub, allowing you to manage customers, invoices, and transactions across multiple Elements. You will need your Recurly account to add an instance.",
    "image": "https://cloud.githubusercontent.com/assets/4119349/24875787/7ff95a3a-1de6-11e7-86c4-b844167212c1.png",
    "logo": "recurly",
    "active": true,
    "deleted": false,
    "typeOauth": false,
    "trialAccount": false,
    "resources": [],
    "objects": [],
    "transformationsEnabled": true,
    "bulkDownloadEnabled": true,
    "bulkUploadEnabled": true,
    "cloneable": true,
    "extendable": false,
    "beta": false,
    "authentication": {
      "type": "custom"
    },
    "extended": false,
    "useModelsForMetadata": true,
    "hub": "billing",
    "protocolType": "http",
    "parameters": [],
    "private": false
  },
  "user": {
    "id": 184978
  }
}