Embedded Files
Context
Context
All calls to the API require 2 keys: an endpoint key and a user key.
Endpoint Key: The endpoint key validates that the user is authorised to use the given endpoint
User Key: The user key is used to identify the user making the call.
Accessing this page
Accessing this page
From the menu, select 'Config Workbench' under the 'Administration' section.
From the configuration workbench, select 'API Keys' from the 'Integrations' section.
Key Security
Key Security
Creating API Keys requires a user to have the grant 'Create API Keys'
Managing API Keys requires a user to have the grant 'Manage API Keys'
Creating an Endpoint Key
Creating an Endpoint Key
To access the API Keys dashboard, click on the pull-down menu and select Config Workbench from the Administration section. From the Config Workbench select 'API Keys' from the Integrations section
Click on Add Key to create a new endpoint key. A pop-up window will display requesting the attributes for the key.
Click on Create to create the key.
The key will be displayed. Copy the key and store securely as the key is not displayed again.
Creating a User Key
Creating a User Key
To access the API Keys dashboard, click on the pull-down menu and select Config Workbench from the Administration section. From the Config Workbench select 'API Keys' from the Integrations section
Click on Add User Key to create a new user key. A pop-up window will display requesting the attributes for the key.
Click on Generate New Key to create the key.
A warning will be displayed that any previous keys for the user will be expired. Be sure that no previous keys are used elsewhere before generating a new one.
To proceed with generating the user key click on Yes, generate a key
The key will be displayed. Copy the key and store securely as the key is not displayed again.
Using the keys in API calls
Using the keys in API calls
All API calls should include the endpoint key and user key. They are passed in the following parameters:
Example
Example
The following example gets the details of a form with ID 128298
Google Sites
Report abuse