You can authenticate with Infusionsoft to create your own instance of the Infusionsoft REST element through the UI or through APIs. Once authenticated, you can use the element instance to access the different functionality offered by the Infusionsoft platform.
Use the UI to authenticate with Infusionsoft and create a Infusionsoft REST element instance. Infusionsoft authentication follows the typical OAuth 2.0 framework and you will need to sign in to Infusionsoft as part of the process.
If you are configuring events, see the Events section.
To authenticate an element instance:
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.
Authenticating through API is similar to authenticating via the UI. Instead of clicking and typing through a series of buttons, text boxes, and menus, you will instead send a request to our /instances
endpoint. The end result is the same, though: an authenticated element instance with a token and id.
Authenticating through API follows a multi-step OAuth 2.0 process that involves:
Use the following API call to request a redirect URL where the user can authenticate with the service provider. Replace {keyOrId}
with the element key, infusionsoftrest
.
curl -X GET /elements/{keyOrId}/oauth/url?apiKey=<Infusionsoft Key Name>&apiSecret=<Infusionsoft Secret Name> &callbackUrl=<Infusionsoft Callback URL Name>
Query Parameter | Description |
---|---|
apiKey | The API key or client ID obtained from registering your app with the provider. This is the Key Name that you recorded in API Provider Setup. |
apiSecret | The client secret obtained from registering your app with the API provider. This is the Secret Name that you recorded in API Provider Setup. |
callbackUrl | The URL that the API provider returns a user to after they authorize access. This is the Callback URL Name that you recorded in API Provider Setup |
curl -X GET \
'https://api.cloud-elements.com/elements/api-v2/elements/infusionsoftrest/oauth/url?apiKey=Rand0MAP1-key&apiSecret=fak3AP1-s3Cr3t&callbackUrl=https:%3A%2F%2Fwww.mycoolapp.com%2auth' \
Use the oauthUrl
in the response to allow users to authenticate with the vendor.
{
"oauthUrl": "https://signin.infusionsoft.com/app/oauth/authorize?scope=files.readwrite+offline_access&response_type=code&redirect_uri=https%3A%2F%2Fhttpbin.org%2Fget&state=infusionsoftrest&client_id=Rand0MAP1-key",
"element": "infusionsoftrest"
}
Provide the oauthUrl
in the response from the previous step to the users. After users authenticate, Infusionsoft provides the following information in the response:
Response Parameter | Description |
---|---|
code | The authorization grant code returned from the API provider in an OAuth 2.0 authentication workflow. Cloud Elements uses the code to retrieve the OAuth access and refresh tokens from the endpoint. |
state | A customizable identifier, typically the element key (infusionsoftrest ) . |
error
instead of the code
parameter. In this case, your application can handle the error gracefully.
Use the code
from the previous step and the /instances
endpoint to authenticate with Infusionsoft and create an element instance. If you are configuring events, see the Events section.
To authenticate an element instance:
Construct a JSON body as shown below (see Parameters):
{
"element": {
"key": "infusionsoftrest"
},
"providerData": {
"code": "<AUTHORIZATION_GRANT_CODE>"
},
"configuration": {
"oauth.api.key": "<Infusionsoft app Key Name>",
"oauth.api.secret": "<Infusionsoft app Secret Name>",
"oauth.callback.url": "<Infusionsoft app Callback URL Name >"
},
"tags": [
"<Add_Your_Tag>"
],
"name": "<INSTANCE_NAME>"
}
Call the following, including the JSON body you constructed in the previous step:
POST /instances
Locate the token
and id
in the response and save them for all future requests using the element instance.
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": "infusionsoftrest"
},
"providerData": {
"code": "xxxxxxxxxxxxxxxxxxxxxxx"
},
"configuration": {
"oauth.api.key": "Rand0MAP1-key",
"oauth.api.secret": "fak3AP1-s3Cr3t",
"oauth.callback.url": "https://mycoolapp.com"
},
"tags": [
"Docs"
],
"name": "API Instance"
}'
API parameters in the UI are bold, while parameters available in the instances API are in code formatting
.
Parameter | Description | Data Type |
---|---|---|
key |
The element key. infusionsoftrest |
string |
code |
The authorization grant code returned from the API provider in an OAuth 2.0 authentication workflow. Cloud Elements uses the code to retrieve the OAuth access and refresh tokens from the endpoint. | string |
Namename |
The name of the element instance created during authentication. | string |
oauth.api.key |
The API key or client ID obtained from registering your app with the provider. This is the Key Name that you noted in API Provider Setup. | string |
oauth.api.secret |
The client secret obtained from registering your app with the API provider. This is the Secret Name that you noted in API Provider Setup. | string |
oauth.callback.url |
The URL that the API provider returns a user to after they authorize access. This is the Callback URL Name that you noted in API Provider Setup. | string |
Tagstags |
Optional. User-defined tags to further identify the instance. | string |
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": "API Instance",
"createdDate": "2017-08-07T18:46:38Z",
"token": "ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
"element": {
"id": 11748,
"name": "Infusionsoft REST",
"key": "infusionsoftrest",
"description": "Add an Infusionsoft Instance to connect your existing Infusionsoft account to the CRM Hub, allowing you to manage contacts, leads, accounts, opportunities etc. across multiple CRM Elements. You will need your Infusionsoft account information to add an instance.",
"image": "elements/provider_infusionsoftrest.png",
"active": true,
"deleted": false,
"typeOauth": false,
"trialAccount": false,
"bulkDownloadEnabled": false,
"resources": [ ],
"transformationsEnabled": true,
"bulkDownloadEnabled": true,
"bulkUploadEnabled": true,
"cloneable": true,
"extendable": true,
"beta": false,
"authentication": {
"type": "oauth2"
},
"extended": false,
"hub": "crm",
"protocolType": "http",
"parameters": [ ],
"private": false
},
"elementId": 11748,
"tags": [
"Docs"
],
"provisionInteractions": [],
"valid": true,
"disabled": false,
"maxCacheSize": 0,
"cacheTimeToLive": 0,
"providerData": {
"code": "evcfr8vfne4smad3nbnw652e"
},
"configuration": { },
"eventsEnabled": false,
"traceLoggingEnabled": false,
"cachingEnabled": false,
"externalAuthentication": "none",
"user": {
"id": 12345
}
}