If you want to start exploring the Symplify API you need to create an API Key to which you'll generate a token used for authenticating your requests.
API Key
To create your API Key you go to Settings > (Integration) API keys an click on Add.
A panel will open to your right where you'll add a user name. Allowed characters for user names are:
- A-Z, a-z
- 0-9
- . (dot)
- @ (at)
- - (hyphen)
- + (plus)
- _ (underscore)
Add the contact details of the person responsible for the API key and hit Add.
Activate "Only for use as embedded token in Mobile app" if your API key is to be used from an external application, e.g. your mobile app. Security wise, this token type is safe to distribute in an app as it has a limited scope and is not allowed to retrieve any data about a contact to the app.
API Tokens
To generate a new token to your API key, click on the name (or the cogs) to open the side panel.
In the top of the panel you simply click the + (plus icon) to generate a token.
When a token is created you're able to update, delete copy and test your token.
The token is paired with "X-Carma-Authentication-Token" for authentication:
"X-Carma-Authentication-Token": "YourToken"