With the Skeepers API (v2.0), you can connect your services to Skeepers to leverage the feedback and data collected in your own tools (CRM, email platform, in-house software).
Accessibility
First of all, it is important to note that to access the Skeepers API configuration, you must be one of the administrators of your organization's account.
An administrator (also called the operational account manager) is a "super user" who holds admin access to your organization's Skeepers account in the Feedback Management platform. They are usually designated at the start of the partnership with Skeepers. Afterwards, they manage the creation and management of Skeepers Feedback Management access for your organization's account. They hold this right:
If you are not an administrator, we invite you to contact them within your organization to carry out the API configuration with you.
Configuring the Skeepers API for a standard account
If you are administrator, you are independent in using the Skeepers API, and you can create as many API users as you want from your account.
- Click at the top right of the platform to open the panel where you can choose to access your user account settings, your organization's Skeepers Feedback Management account settings, or log out of the platform.
- Click on 'Settings for [YOUR ORGANIZATION'S SKEEPERS ACCOUNT]'.
- In your organization's account settings, open the 'API' tab. You will find the link to the API documentation and the list of all API users created on your organization's Skeepers account.
- Then press the button
.
Once on the API setup page, just like a regular user, you can choose to assign more or fewer roles, rights, and permissions to your API user.
If in doubt, feel free to consult the article detailing the impact of activating each right: The different roles and rights available on the platform.
You have full autonomy in configuring the Skeepers API.
Given the technical knowledge required for its setup, our technical experts provide you access to the Skeepers API documentation which details all possible API calls.
Retrieving the status of feedback (invalid/test, valid) is possible. However, the API can only retrieve feedbacks in production, meaning those identified as "valid". To get the status of feedback, please consult the request detailed in the API documentation provided.
Configuring the Skeepers API for a parent account
If you are administrator, you are independent in using the Skeepers API, and you can create as many API users as you want from your account.
- Click on the 'Accounts' section of the platform's left-hand menu.
- In your organization's account settings, open the 'API' tab. You will find the link to the API documentation and the list of all API users created on your organization's Skeepers account.
- Then press the button
Once on the API setup page, just like a regular user, you can choose to assign more or fewer roles, rights, and permissions to your API user.
If in doubt, feel free to consult the article detailing the impact of activating each right: The different roles and rights available on the platform.
You have full autonomy in configuring the Skeepers API.
Given the technical knowledge required for its setup, our technical experts provide you access to the Skeepers API documentation which details all possible API calls.
Retrieving the status of feedback (invalid/test, valid) is possible. However, the API can only retrieve feedbacks in production, meaning those identified as "valid". To get the status of feedback, please consult the request detailed in the API documentation provided.
How tokens work
Session token
A session token allows authentication and authorization of API requests on the platform. This token is generated each time the API user logs in and is then included in API requests to identify the user and their associated permissions.
In summary, the session token acts as a temporary and secure identifier that allows the API to access the platform's features and data, while ensuring the security and confidentiality of exchanged information.
In Skeepers, session tokens are valid for 5 minutes, and the expiration date is displayed on the platform. If the 'Refresh' button is clicked, a new session token will be generated and the validity of the refresh token will be extended by 30 days.
Refresh token
A refresh token is a type of token used in OAuth authentication systems to obtain new session tokens without requiring the API user to log in again.
In summary, the refresh token is a mechanism that maintains an active session and ensures continuous and secure access to Skeepers features via its API.
A refresh token remains valid as long as it is used regularly. It will stay active as long as regular interactions with Skeepers are maintained, otherwise, it will expire prematurely.
If you have any questions, feel free to contact our Customer Care team.