Generating an API token
Why generate a token?
When you want to push or pull data from and to the platform, you need to generate (an) API token(s). Each token sets the permissions for the API connection and defines :
- the type of call
- duration of the open connection (max. 1 year)
Having these detailed settings make sure that you can take full responsibility for the platform security and set specific permission for al incoming and outgoing data. You generate the token in our platform and then paste it your API management tool.
Some general information regarding the generation of API tokens:
- The API's are triggered by a Token. When creating this token you can choose the touchpoints which should be connected to this token and choose the expiration date. Our API tokens can be valid from 1 to 12 months.
- When you are creating the token, you can easily select the touchpoint and link this to the token. Once you have saved these settings you will be unable to adjust or add touchpoints to this token.
- Whenever you want to activate a new Touchpoint, you will have to create a new token as you can not add touchpoints to a token which is already in use. When the token is expired you can then group the touchpoints in a new token.
- API connectors which are expired can be deleted on the fly. If the token is still in use, it can not be deleted.
How to generate a token:
Go to touchpoint setting and select API connectors.
The API Connectors page has the following overview:
1. Name of the token - pick something that describes the connection if you're going to built multiple connection
2. Valid for - states for how long the token can be used
3. Expiration date: contains the expiration date and how much time you have left before you need to renew the token
4. Notification: who will be notified when the token is about to expire (a notificiation will be sent 2 weeks before the expiration date)
5. Pencil icon: edit an existing connector
6. Copy the token to the clipboard
To make a new API token, click on 'create new' in the top right corner. Add a name and a time period.
Switch the toggle on/off depending on wether a Fixed IP is required.
Now, set the priviliges for the connection, or in other words, select the API calls that are allowed for the touchpoint you're going to connect.
The add who needs to be notified when the token is about to expire.
And then lastly, select the touchpoint you want to connect by clicking 'Add Touchpoint'
When the touchpoint is connected, scroll back up and click the green 'save and generate token' button.
A token will be generated and ready to paste in your internal systems. Click finish to end.
IMPORTANT: You will only ba able to copy this token once. Make sure you save it somewhere locally, as you will not be able to access it again.
The new connector is now added in the overview page.