Share
Managing configurator share module
GET /configurator-share
Simplio3D API: Get List of Configurator Shares
Endpoint
HTTP Method:
GETURL:
/open-api/v1/configurator-share
Description
This endpoint retrieves a list of all configurator shares available to the authenticated user.
Request Headers
Authorization: Bearer token for authenticating the API request.
Response
Status Code:
200 OK
NOTE: Ensure you have the necessary authorization credentials (e.g., Bearer Token) to access this endpoint which is taken from the 'Share' tab encryption token found at the bottom of the page.
GET /configurator-share/{id}
Get Configurator Share by ID
The Simplio3D API provides a straightforward method to fetch the details of a specific configurator share using its unique identifier. This endpoint is beneficial when you need information on a particular configurator share without retrieving the entire list.
Endpoint Overview
HTTP Method: GET
Endpoint: /open-api/v1/configurator-share/{id}
Headers
Authorization: Bearer token for authenticating the API request. Ensure that the token has the necessary permissions to access the configurator share data.
Parameters
id: The unique identifier of the configurator share you wish to retrieve. This is a path parameter and is required to access the specific share.
Example Request
Here's how you can make a request to fetch a configurator share by its ID:
Response
Upon successful retrieval, the API will respond with the following:
Status Code:
200 OKUnauthorized: 401
Configurator share not found: 404
Internal server error: 500
NOTE: Ensure you have the necessary authorization credentials (e.g., Bearer Token) to access this endpoint which is taken from the 'Share' tab encryption token found at the bottom of the page.
Last updated
Was this helpful?