Table of Contents | ||
---|---|---|
|
How to use this
...
page
This documentation provides a high level overview of some of the common use cases for the 3YOURMIND RESTful API.
...
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 scenarios outlined below, please feel free to reach out to the Technical Support Team with your queries or suggestions.
API Documentation
To reach the API documentation for your platform, please append the /apidocs/
endpoint to the site URL (e.g, order.yoursite.com/apidocs/
).
Authentication
An API token is required to use the REST API and this token is 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 permissions 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. https://3yourmind.atlassian.net/wiki/spaces/PD/pages/edit-v2/1989705741#API-Documentation
API Use Cases
Create a Quote based on a RequestForQuote while choosing a custom price for the Quote-Lines
...