Share

Managing configurator share module

GET /configurator-share

Simplio3D API: Get List of Configurator Shares

Endpoint

• HTTP Method: GET

• URL: /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

• Response Body:

  • An array of configurator share objects. Each object contains:

    • id: Unique identifier for the configurator share.

    • name: Name of the configurator.

    • created_at: Timestamp of when the share was created.

    • updated_at: Timestamp of the last update.

    Example

    Request

    GET /open-api/v1/configurator-share
    Authorization: Bearer <token>

    Successful Response

    [
        {
            "id": "12345",
            "name": "Configurator Name",
            "created_at": "2023-05-01T12:00:00Z",
            "updated_at": "2023-06-01T12:00:00Z"
        },
        ...
    ]

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 list of configurator shares

get

https://app.simplio3d.com

/api/open-api/v1/configurator-share

Get all configurator shares.

Authorizations

bearerAuth

AuthorizationstringRequired

Enter token in format (Bearer <your_token>)

Responses

200

List of configurator shares retrieved successfully

application/json

401

Unauthorized

500

Internal Server Error

get

/api/open-api/v1/configurator-share

HTTPcURLJavaScriptPython

GET /api/open-api/v1/configurator-share HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": 1,
    "configurator_id": 127,
    "share_url": "https://example.com/share/xyz",
    "enable_sidebar": true,
    "enable_ar": false,
    "dark_theme": false,
    "show_dimensions": false,
    "domain_name": "example.com",
    "created_at": "2024-02-25T12:00:00Z",
    "updated_at": "2024-02-25T12:30:00Z"
  }
]

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:

GET /open-api/v1/configurator-share/12345
Authorization: Bearer <token>

Response

Upon successful retrieval, the API will respond with the following:

• Status Code: 200 OK

• Unauthorized: 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.

Get configurator share by ID

get

https://app.simplio3d.com

/api/open-api/v1/configurator-share/{id}

Get a specific configurator share by ID.

Authorizations

bearerAuth

AuthorizationstringRequired

Enter token in format (Bearer <your_token>)

Path parameters

idinteger · int64Required

ID of the configurator share

Responses

200

Configurator share retrieved successfully

application/json

401

Unauthorized

404

Configurator share not found

500

Internal Server Error

get

/api/open-api/v1/configurator-share/{id}

HTTPcURLJavaScriptPython

GET /api/open-api/v1/configurator-share/{id} HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": 1,
  "configurator_id": 127,
  "share_url": "https://example.com/share/xyz",
  "enable_sidebar": true,
  "enable_ar": false,
  "dark_theme": false,
  "show_dimensions": false,
  "domain_name": "example.com",
  "created_at": "2024-02-25T12:00:00Z",
  "updated_at": "2024-02-25T12:30:00Z"
}