After logging in, you can use all of our API endpoints to access Trayn programmatically. The API endpoints are the same as those used by our web app.
Note: We regularly update the API and there will be breaking changes. The processes are not streamlined yet, so please let us know what you are working on and we will send you documentation and keep you in the loop.
As an administrator, you can enable developer settings from your profile. In the top section, Profile & Configuration, you will see Developer Settings
API Keys
When sending requests to our REST API you need an API key to authenticate. You can generate keys or delete any key that is no longer used from the Developer Settings.
When generating a new key you have to provide your current password and some name for the key. The new key will only be shown once to you.
You have to include your key as token to authenticate your request. The following example would use the JavaScript fetch method to get the number of currently unread conversation messages. You'll have to replace YOUR_API_KEY with your actual key.
fetch("https://api.trayn.com/backend/rest/s/conversation/unread", {
"headers": {
"accept": "application/json",
"authorization": "token YOUR_API_KEY",
},
"method": "GET",
});
Once you have created one or more keys, a new section will appear which allows you to review your key's state.
Note: If you don't need a key any longer or have the suspicion it might be misused, you should delete it.
Developer Mode
From the Developer Settings, you can enable Developer Mode for the current device
This will store a flag in your browser and enable the Copy ID button in some places throughout the UI. This will make referencing objects in Trayn easier.