You can authenticate with Infusionsoft to create your own instance of the Infusionsoft Marketing Automation 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.
Authenticate Through the UI
Use the UI to authenticate with Infusionsoft and create an element instance. Because you authenticate with Infusionsoft via OAuth 2.0, all you need to do is add a name for the instance and provide your Infusionsoft server name and encrypted key. After you create the instance, you'll log in to Infusionsoft to authorize Cloud Elements access to your account. For more information about authenticating an element instance, see Authenticate an Element Instance (UI).
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
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:
- Getting a redirect URL. This URL sends users to the vendor to log in to their account.
- Authenticating users and receiving the authorization grant code. After the user logs in, the vendor makes a callback to the specified url with an authorization grant code.
- Authenticating the element instance. Using the authorization code from the vendor, authenticate with the vendor to create an element instance at Cloud Elements.
Getting a Redirect URL
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, infusionsoftmarketing
.
curl -X GET /elements/{keyOrId}/oauth/url?apiKey=<api_key>&apiSecret=<api_secret>&callbackUrl=<url>&siteAddress=<url>
Query Parameters
Query Parameter | Description |
---|---|
apiKey | The API key or client ID obtained from registering your app with the provider. This is the client_id that you recorded in the API Provider Setup section. |
apiSecret | The client secret obtained from registering your app with the API provider. This is the client_secret that you recorded in the API Provider Setup section. |
callbackUrl | The URL that the API provider returns a user to after they authorize access. This is the Callback URL that you recorded in the API Provider Setup section. |
Example cURL
curl -X GET \
'https://api.cloud-elements.com/elements/api-v2/elements/infusionsoftmarketing/oauth/url?apiKey=fake_api_key&apiSecret=fake_api_secret&callbackUrl=https://www.mycoolapp.com/auth&state=infusionsoftmarketing' \
Example Response
Use the oauthUrl
in the response to allow users to authenticate with the vendor.
{
"oauthUrl": "https://signin.infusionsoft.com/app/oauth/authorize?scope=full&response_type=code&redirect_uri=https%3A%2F%2Fhttpbin.org%2Fget&state=infusionsoftcrm&client_id=4ynetc9z7v6vajwvkwvxvgxj",
"element": "infusionsoftcrm"
}
Authenticating Users and Receiving the Authorization Grant Code
Provide the response from the previous step to the users. After they authenticate, Infusionsoft Marketing Automation provides the following information in the response:
- code
- state
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 (infusionsoftmarketing ) |
error
instead of the code
parameter. In this case, your application can handle the error gracefully.Authenticating the Element Instance
Use the /instances
endpoint to authenticate with Infusionsoft Marketing Automation and create an element instance.
To authenticate an element instance:
Construct a JSON body as shown below (see Parameters):
{ "element": { "key": "infusionsoftmarketing" }, "providerData": { "code": "<AUTHORIZATION_GRANT_CODE>" }, "configuration": { "oauth.callback.url": "<CALLBACK_URL>", "oauth.api.key": "<CONSUMER_KEY>", "oauth.api.secret": "<CONSUMER_SECRET>", "infusionsoft.server": "<ACOUNT_URL>", "infusionsoft.private.key": "<ENCRYPTED_KEY>" }, "tags": [ "<Add_Your_Tag>" ], "name": "<INSTANCE_NAME>" }
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. For more information, see Authorization Headers, Organization Secret, and User Secret.Locate the
token
andid
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": "infusionsoftmarketing"
},
"providerData": {
"code": "xxxxxxxxxxxxxxxxxxxxxxx"
},
"configuration": {
"oauth.callback.url": "https;//mycoolapp.com",
"oauth.api.key": "xxxxxxxxxxxxxxxxxx",
"oauth.api.secret": "xxxxxxxxxxxxxxxxxxxxxxxx",
"infusionsoft.server": "dt123.infusionsoft.com",
"infusionsoft.private.key": "47dxxxxxxxxxxxxxxxxxxxx"
},
"tags": [
"Docs"
],
"name": "API Instance"
}'
Parameters
API parameters not shown in Cloud Elements are in code formatting
.
Parameter | Description | Data Type |
---|---|---|
key | The element key. infusionsoftmarketing | 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 client_id that you noted in the API Provider Setup section. | string |
oauth.api.secret | The client secret obtained from registering your app with the API provider. This is the client_secret that you noted in the API Provider Setup section. | string |
oauth.callback.url | The API key or client ID obtained from registering your app with the provider. This is the Callback URL that you noted in the API Provider Setup section. | string |
Infusionsoft Serverinfusionsoft.server | The account portion of your Infusionsoft URL. For example, if your account url is https://dt123.infusionsoft.com enter dt364.infusionsoft.com . You can also enter https://dt123.infusionsoft.com . | string |
Infusionsoft Encrypted Keyinfusionsoft.private.key | The encrypted API key that you noted in the API Provider Setup section. | string |
tags | Optional. User-defined tags to further identify the instance. | string |
Example Response for an Authenticated Element Instance
{
"id": 1234,
"name": "Test",
"token": "a5y4EtYt+ZYRpnIBD7gkQtthDebK8qKVU=",
"element": {
"id": 126,
"name": "Infusionsoft Beta",
"key": "infusionsoftmarketing",
"description": "Add an Infusionsoft Instance to connect your existing Infusionsoft account to the Marketing Hub, allowing you to manage contacts, leads, accounts, opportunities etc. across multiple Marketing Elements. You will need your Infusionsoft account information to add an instance.",
"image": "http://www.sagepay.co.uk/files/styles/img_220x220/public/partner-logo/infusionsoft-220px.png?itok=yDDuLcdL",
"active": true,
"deleted": false,
"typeOauth": false,
"trialAccount": false,
"resources": [],
"transformationsEnabled": true,
"authentication": {
"type": "oauth2"
},
"hub": "marketing",
"parameters": []
},
"provisionInteractions": [],
"valid": true,
"disabled": false,
"maxCacheSize": 0,
"cacheTimeToLive": 0,
"configuration": {
"oauth.api.secret": "INFUSIONSOFT_API_SECRET",
"base.url": "https://fm260.infusionsoft.com/api/xmlrpc",
"oauth.token.url": "https://api.infusionsoft.com/token",
"pagination.max": "100",
"event.vendor.type": "webhook",
"oauth.scope": "full",
"oauth.user.token": "INFUSIONSOFT_USER_TOKEN",
"oauth.authorization.url": "https://signin.infusionsoft.com/app/oauth/authorize",
"event.notification.callback.url": null,
"oauth.callback.url": "https://mycoolapp.com/auth",
"oauth.user.refresh_token": "OAUTH_REFRESH_TOKEN",
"oauth.user.refresh_interval": "28800",
"oauth.api.key": "INFUSIONSOFT_API_KEY",
"oauth.user.refresh_time": "1436369668710",
"event.notification.enabled": "false"
},
"eventsEnabled": false,
"cachingEnabled": false,
"traceLoggingEnabled": false
}