At SpringCM, we love to empower our users. Our rest API offers a dynamic way to interact with your content. Whether you are building your own application, customizing a web form, or writing a script to run batch processes, a REST API key is your gateway to interacting with the SpringCM Rest API.
This article serves as a guide to help to understand the process of requesting an API key, and then subsequently generating an API secret.
Note: Only users of the role “Super Administrator” can link an API Key to an API User following the API User Authentication Flow process.
How to Request a Key
Please follow the below steps to request an API key and generate a secret:
- Make a request to the support team by opening up a support ticket here and selecting the category “API & Development.”
- Please submit the following information within the ticket body:
Account ID: This can be extracted from the URL.
Email Address: This needs to be the email address of a user within the account you are generating an API key for.
Environment: Either UAT or Production.
- Once the support team receives your request we will reply with your API Key in the support ticket.
- We will send a separate email (using the email address supplied in step 2) with a link to generate your client secret. You will be only able to generate the client secret if you are logged into an account linked to that email address in the correct environment.
Tips from Support
Securely store your API key and secret as we cannot recover these. A new key/secret combo will need to be generated if you misplace this information. For further details about using our API, please visit developer.springcm.com.