What is an API Token?
An API Token is a unique, secure key that can be used to grant authenticated access to the Catapult Connect API, accessing data stored on your OpenField account and for integration with external systems. API Tokens can be created with specific scopes to limit the access of an external system to your OpenField data.
**Treat this token like a password
Treat this token like a password. Do not share it unnecessarily or store it in an unprotected system or location. A separate token should be generated for each integration. Integration tokens cannot be refreshed programmatically. API tokens should also not be shared over email for security purposes. Ideally, they are cut and pasted directly into the system they are using the token for.
How can I generate an API Token?
The 'API Token Admin' module must be enabled for your OpenField account. If you want to add the module please contact support for assistance.
-
Navigate to the OpenField Cloud and click on 'Settings'.
-
Click on 'API Tokens' from the left hand Settings menu.
-
In the text box, select or enter the name of the system you want OpenField to integrate with.
-
Click the checkbox beside 'Token never expires' or select a expiry date for the token from the Date picker.
-
Select the scope of the token.
-
Select Create.
-
From the next menu, copy the API Token to the clipboard and use for the intended integration. You will not be able to view this token again once the window closes.
- Select 'Close'.
How can I revoke an API Token?
-
Navigate to the OpenField Cloud and click on 'Settings'.
-
Click on 'API Tokens' from the left hand Settings menu.
-
From the Action column, click Revoke for any API Tokens you want to void.
-
Select 'Confirm' from the next prompt to complete the process.
