Options

Managing Configurator Options

GET /configurator-options/types/list

Retrieve Available Configurator Option Types

Endpoint

GET /open-api/v1/configurator-options/types/list

Description

This endpoint retrieves the list of available configurator option types supported by Simplio3D.

Request Headers

Authorization: Bearer token for authentication

Response

200 OK: Returns a JSON object containing an array of available option types.
400 Bad Request: Invalid request parameters.
401 Unauthorized: Invalid or missing authentication token.

Example Response

{
  "optionTypes": [
    "color",
    "size",
    "material",
    "custom-text"
  ]
}

Notes

Ensure you have valid authentication to access this endpoint.
Utilize the retrieved option types to understand and configure products efficiently within Simplio3D.
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.

Retrieve available configurator option types

get

/api/open-api/v1/configurator-options/types/list

Get a list of available configurator option types.

Authorizations

AuthorizationstringRequired

Enter token in format (Bearer <your_token>)

Responses

200

List of configurator option types

application/json

401

Unauthorized request

500

Internal server error

get

/api/open-api/v1/configurator-options/types/list

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

{
  "data": [
    {
      "default": "Default",
      "checkbox": "Checkbox",
      "material": "Material",
      "numeral": "Numeral",
      "radio": "Toggle",
      "section": "Section",
      "select": "Dropdown",
      "select_thumb": "Thumbnails",
      "text": "Text",
      "upload": "Upload",
      "arrows": "Arrows",
      "patterns": "Patterns",
      "canvas": "Canvas",
      "repeat": "Repeat",
      "rotation": "Rotation"
    }
  ]
}

GET /configurator-option/{id}

Retrieve details of a specific configurator option using its ID.

`GET /configurator-option/{id}`

Request

Endpoint: /configurator-option/{id}
Method: GET
Authentication: Required

Parameters

id (string): The unique identifier of the configurator option.

Response

A successful request returns a JSON object with details of the configurator option, including:

id (string): The unique identifier of the option.
name (string): The name of the option.
description (string, optional): A description of the option.
type (string): The type of option, e.g., "color", "size".
values (array): The possible values for this option.

Example Request

GET /configurator-option/12345 HTTP/1.1
Authorization: Bearer YOUR_ACCESS_TOKEN
Host: api.simplio3d.com

Example Response

{
  "id": "12345",
  "name": "Color",
  "description": "Select the color for the product",
  "type": "color",
  "values": ["red", "green", "blue"]
}

Notes

Ensure proper handling of the authentication token in your API calls.
Use this endpoint to look up and validate option specifications for product configurators.
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 option by ID

get

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

Get a specific configurator option by ID.

Authorizations

AuthorizationstringRequired

Enter token in format (Bearer <your_token>)

Path parameters

idinteger · int64Required

ID of the configurator option

Responses

200

Successful response

application/json

401

Unauthorized

404

Configurator option not found

500

Server error

get

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

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

{
  "id": 1,
  "configurator_id": 10,
  "title": "Color Selection",
  "option_type": "dropdown",
  "settings": "{'min':1,'max':5}",
  "parameter_list": "['red', 'blue', 'green']",
  "order": 2,
  "created_at": "2024-02-21T10:00:00Z",
  "updated_at": "2024-02-22T12:00:00Z",
  "created_by": "John Doe"
}

GET /configurator-options

Fetch All Configurator Options

To retrieve all configurator options, use the GET /configurator-options endpoint. This endpoint returns a list of options available for product configuration.

Request

Method: GET
Endpoint: /configurator-options
Headers:
- Authorization: Bearer <your_auth_token>
Response
A successful response will return a JSON object with details such as option id, name, description, type, and values.

Example Response

[
  {
    "id": "12345",
    "name": "Color",
    "description": "Select the color for the product",
    "type": "color",
    "values": ["red", "green", "blue"]
  },
  {
    "id": "67890",
    "name": "Size",
    "description": "Choose the size for the product",
    "type": "dropdown",
    "values": ["small", "medium", "large"]
  }
]

Notes

Ensure that the authentication token is included in the request header to access the endpoint successfully.
Use this data to validate and check available options for product configurators efficiently.
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.

Fetch all configurator options

get

/api/open-api/v1/configurator-options

Get a list of configurator 3D assets models.

Authorizations

AuthorizationstringRequired

Enter token in format (Bearer <your_token>)

Query parameters

order_bystringOptional

Column to order results by (e.g., 'created_at')

Example: created_at

orderstring · enumOptional

Sorting order (asc or desc)

Example: descPossible values:

per_pageintegerOptional

Number of records per page (-1 for all records)

Example: 25

pageintegerOptional

Number of page

Example: 2

Responses

200

List of configurator options

application/json

400

Invalid request parameters

401

Unauthorized request

403

Forbidden - user does not have permission

500

Internal server error

get

/api/open-api/v1/configurator-options

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

{
  "data": [
    {
      "id": 1,
      "configurator_id": 10,
      "title": "Color Selection",
      "option_type": "dropdown",
      "settings": "{'min':1,'max':5}",
      "parameter_list": "['red', 'blue', 'green']",
      "order": 2,
      "created_at": "2024-02-21T10:00:00Z",
      "updated_at": "2024-02-22T12:00:00Z",
      "created_by": "John Doe"
    }
  ]
}

GET /configurator-options-variations

Retrieve a List of Configurator Option Variations

To retrieve a list of configurator option variations, you will need to make a GET request to the Simplio3D API endpoint designed for this purpose. Below is a brief explanation of how to interact with this endpoint:

Endpoint:

GET /api/configurator-options-variations

Headers:

Authorization: Bearer YOUR_AUTH_TOKEN

Response Format:

The endpoint responds with a JSON array where each element contains details about a specific configurator option. Example structure of each item in the array:

id: Unique identifier for the option.
name: Name of the option.
description: Brief description of the option.
type: Type of input field (e.g., "color", "dropdown").
values: An array of possible values.

Ensure to replace YOUR_AUTH_TOKEN with your actual authentication token and verify that your request headers are correctly set for successful interaction with the API.

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.

Retrieve a list of configurator option variations

get

/api/open-api/v1/configurator-option-variations

Get a list of configurator option variations.

Authorizations

AuthorizationstringRequired

Enter token in format (Bearer <your_token>)

Query parameters

configurator_option_idintegerOptional

The ID of the configurator option for which to retrieve variations.

Example: 45

Responses

200

List of configurator option variations

application/json

400

Invalid request parameters

401

Unauthorized request

403

Forbidden - user does not have permission

500

Internal server error

get

/api/open-api/v1/configurator-option-variations

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

{
  "data": [
    {
      "id": 1,
      "configurator_id": 127,
      "configurator_option_id": 45,
      "configurator_option_value": "Red",
      "title": "Red Glossy",
      "name": "Glossy Finish",
      "settings": "{}",
      "created_at": "2024-02-25T12:00:00Z",
      "updated_at": "2024-02-25T12:30:00Z"
    }
  ]
}

To set configurator options using a POST request in Simplio3D, ensure you include your Open API token in the request headers for authentication. Your request should contain the configurator option details in JSON format. Here's a sample structure:

{
  "id": "option1",
  "name": "Color Selection",
  "description": "Choose your preferred color",
  "type": "dropdown",
  "values": ["Red", "Green", "Blue"]
}

Always verify that your API token is correctly placed in the headers for seamless interaction.

Set configurator options using Open API token

post

/api/open-api/v1/configurator-options/set/new-options

Set and save configurator options for a user token.

Authorizations

AuthorizationstringRequired

Enter token in format (Bearer <your_token>)

Body

optionsstringRequired

JSON formatted Configurator options override data.

Example: {}

Responses

200

Configurator options updated successfully

application/json

404

Invalid or missing Open API Token ID

application/json

500

Unexpected server error

application/json

post

/api/open-api/v1/configurator-options/set/new-options

POST /api/open-api/v1/configurator-options/set/new-options HTTP/1.1
Host: app.simplio3d.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: multipart/form-data
Accept: */*
Content-Length: 16

{
  "options": "{}"
}

{
  "success": true,
  "message": "Configurator options updated successfully.",
  "data": "https://example.com/configurator/share/abc123/web/xyz456"
}

Using GET for Configurator Option Sets with OpenAPI

To retrieve all configurator option sets in Simplio3D, use a GET request. Ensure your Open API token is included in the headers for authentication. By sending the request to the appropriate endpoint, you will receive a JSON response containing all available configurator options.

Get all configurator options sets

get

/api/open-api/v1/configurator-options/get/new-options

Get all configurator options sets for the given configurator ID and user ID.

Authorizations

AuthorizationstringRequired

Enter token in format (Bearer <your_token>)

Responses

200

List of configurator options sets

application/json

404

Open API token not found

500

Unexpected server error

get

/api/open-api/v1/configurator-options/get/new-options

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

{
  "success": true,
  "message": "Configurator options sets retrieved successfully",
  "data": [
    {
      "id": 1,
      "configurator_id": 10,
      "options": [
        {
          "id": 1,
          "configurator_id": 10,
          "options": [
            "[Circular Reference]"
          ],
          "created_at": "2024-02-21T10:00:00Z",
          "updated_at": "2024-02-22T12:00:00Z"
        }
      ],
      "created_at": "2024-02-21T10:00:00Z",
      "updated_at": "2024-02-22T12:00:00Z"
    }
  ]
}

PreviousOptions NextOption Variations

Last updated 3 months ago

Was this helpful?