How to use this documentation
This documentation provides a high level overview of some of the common use cases for the 3YOURMIND RESTful API.
More details for each use case listed below, can be found by clicking on the title of the use case. In some cases, these more detailed descriptions will include examples for how the API request can be formatted for this particular use case. Where relevant, the required endpoints will be listed in the use case description and the link to the endpoint description, as defined in the API documentation, will be included.
If there is a common use case which you think would be valuable to be included as part of this documentation, or if you have any questions about the use cases outlined below, please feel free to reach out to the Technical Support Team with your queries or suggestions.
Authentication
An API token is required to use the REST API. It can be generated in the admin panel (www..your-domain.com/admin). In the admin panel, open the list of users and click ‘Create token’ next to the chosen user. Please ensure that this user profile has the necessary permission to complete the actions specified in the API request. More information on User Roles, can be found in the following documentation: Roles & User Rights.
Customers who do not have access to the admin panel need to contact the 3YOURMIND support team to obtain a token.
The API Token can be used as outlined in the API Documentation: Authentication.