Acuity Scheduling Authenticate a Connector

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

Authenticate Through the UI

Use the UI to authenticate with Acuity Scheduling and create a connector instance. Because you authenticate with Acuity Scheduling via OAuth 2.0, all you need to do is add a name for the instance. After you create the instance, you'll log in to Acuity Scheduling to authorize Axway AMPLIFY to access your account. For more information about authenticating a connector instance, see Authenticate a Connector 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 connector 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 connector instance. Using the authorization code from the vendor, authenticate with the vendor to create a connector instance at Axway AMPLIFY.

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 connector key, acuityscheduling.

curl -X GET /elements/{keyOrId}/oauth/url?apiKey=<Acuity Scheduling Client ID>&apiSecret=<Acuity Scheduling Client Secret> &callbackUrl=<Acuity Scheduling Redirect URI>

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 Redirect URI that you recorded in the API Provider Setup section.

Example Request

curl -X GET \
'https://api.cloud-elements.com/elements/api-v2//elements/acuityscheduling/oauth/url?apiKey=Rand0MAP1-key&apiSecret=fak3AP1-s3Cr3t&callbackUrl=https:%3A%2F%2Fwww.mycoolapp.com%2auth' \

Example Response

Use the oauthUrl in the response to allow users to authenticate with the vendor.

{
    "oauthUrl": "https://acuityscheduling.com/oauth2/authorize?scope=api-v1&response_type=code&redirect_uri=https%3A%2F%2Fhttpbin.org%2Fget&state=acuityscheduling&client_id=Rand0MAP1-key",
    "element": "acuityscheduling"
  }

Authenticating Users and Receiving the Authorization Grant Code

Provide the oauthUrl in the response from the previous step to the users. After users authenticate, Acuity Scheduling 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. Axway AMPLIFY uses the code to retrieve the OAuth access and refresh tokens from the endpoint.
state A customizable identifier, typically the connector key (acuityscheduling).
Icon

If the user denies authentication and/or authorization, there will be a query string parameter called error instead of the code parameter. In this case, your application can handle the error gracefully.

Authenticating the Connector Instance

Use the code from the previous step and the /instances endpoint to authenticate with Acuity Scheduling and create a connector instance. If you are configuring events, see the Events section.

Icon

The endpoint returns a connector instance token and ID upon successful completion. Retain the token and ID for all subsequent requests involving this connector instance.

To authenticate a connector instance:

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

    {
      "element": {
        "key": "acuityscheduling"
      },
      "providerData": {
        "code": ""
      },
      "configuration": {
        "oauth.api.key": "",
        "oauth.api.secret": "",
        "oauth.callback.url": ""
      },
      "tags": [
        ""
      ],
      "name": ""
    }
    
  2. Call the following, including the JSON body you constructed in the previous step:

    POST /instances
    Icon

    Make sure that you include the User and Organization keys in the header. For more information, see Authorization Headers, Organization Secret, and User Secret.

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

Example Request

curl -X POST \
  https://api.cloud-elements.com/elements/api-v2//instances \
  -H 'authorization: User , Organization ' \
  -H 'content-type: application/json' \
  -d '{
  "element": {
    "key": "acuityscheduling"
  },
  "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"
}'

Authentication Parameters

API parameters in the UI are bold, while parameters available in the instances API are in code formatting.

Icon

Event-related parameters are described in Events.

Parameter Description Data Type
key The connector key.
acuityscheduling
string
code The authorization grant code returned from the API provider in an OAuth 2.0 authentication workflow. Axway AMPLIFY uses the code to retrieve the OAuth access and refresh tokens from the endpoint. string
Name
name
The name of the connector 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 URL that the API provider returns a user to after they authorize access. This is the Redirect URI that you noted in the API Provider Setup section. string
Tags
tags
Optional. User-defined tags to further identify the instance. string

Example Response for an Authenticated Connector 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": "API Instance",
  "createdDate": "2017-08-07T18:46:38Z",
  "token": "ABC/Dxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "element": {
      "id": 6156,
      "name": "Acuity Scheduling",
      "key": "acuityscheduling",
      "description": "Add an Acuity Scheduling Instance to connect your existing Acuity account to the scheduling Hub, allowing you to manage your appointments and events across multiple scheduling connectors.You will need your Google Calendar account information to add an instance",
      "image": "elements/custom-element-default-logo.png",
      "active": true,
      "deleted": false,
      "typeOauth": false,
      "trialAccount": false,
      "resources": [   ],
      "transformationsEnabled": true,
      "bulkDownloadEnabled": false,
      "bulkUploadEnabled": false,
      "cloneable": true,
      "extendable": true,
      "beta": false,
      "authentication": {
          "type": "oauth2"
      },
      "extended": false,
      "hub": "scheduling",
      "protocolType": "http",
      "parameters": [  ],
      "private": false
    },
    "elementId": 6156,
    "tags": [
        "Docs"
    ],
    "provisionInteractions": [],
    "valid": true,
    "disabled": false,
    "maxCacheSize": 0,
    "cacheTimeToLive": 0,
    "providerData": {    },
    "configuration": {    },
    "eventsEnabled": false,
    "traceLoggingEnabled": false,
    "cachingEnabled": false,
    "externalAuthentication": "none",
    "user": {
        "id": 12345
      }
}

Related Links