API Architecture

265265Quable PIM's API is organized on REST (Representational State Transfer) principles. REST is an architectural style that describes how distributed software systems can expose consistent interfaces to their resources.

Data Format

REST APIs only support JSON format. All data created, updated, or retrieved via the Quable PIM API must be in JSON encoded with UTF-8.

API Versions

In our onging efforts to provide the most reliable and stable environment, Quable PIM currently has two API versions:

  • API v4 -This is Quable PIM's most complete API version. It manages all Quable PIM data. It's used primarily for creation and modifications. There are no plans to deprecate this version, however endpoint deprecations are periodically scheduled.

  • API v5 - This is Quable PIM's newest API version. It's used primarily to retrieve most of the Quable PIM data. While this version is continuing to grow, it is stable. There are no plans to deprecate this version, however endpoint deprecations are periodically scheduled.

👍

Both APIs can be used in the same scripts.

Characteristics

Specifications

API v4

API v5

Endpoint - Domain

https://{{YOUR-PIM}}.quable.com

https://{{YOUR-PIM}}.quable.com

Endpoint - Prefix

/api_1.php

/api/

Endpoint Deprecations

API v4 Endpoint Deprecations

API v5 Endpoint Deprecations

Data format accepted in input / output

Autorisation - Type of token

Bearer Token

Bearer Token

Request a token via script

Yes

Yes

Use a predefined global token

Yes (with customer service assistance)

Yes (with customer service assistance)

Multilingual interface contract

No

Yes

HTTP Headers & Verbs/Methods

Quable PIM's REST API endpoints are resource-centric and use the HTTP protocol to access and act upon them.

API v4

API v5

HTTP Headers

  • 'Content-Type': 'application/json'
  • 'Content-Type': application/json
  • 'Content-Type': application/ld+json
  • 'Content-Type': application/hal+json

HTTP Verbs/Methods

Methods are used in accordance with HTTP and resources are identified using URIs. All API requests are sent over HTTPS. The Quable PIM API supports common HTTP verbs/methods

  • GET - Retrieve the representation of a single resource or a list of resources.
  • POST - Create an instance of a resource.
  • PUT - Partially update an existing resource.
  • DELETE - Delete an instance of a resource.
  • GET - Retrieve the representation of a single resource or a list of resources.

Postman Collection

Postman Collections are a good way to group your requests together so you can save, reuse, and share them with others for testing your API calls. You can find the Quable Postman collection here.

🚧

Depending on your contract and the volume of API calls, you may receive responses with the HTTP response code 429. In this case, your applications must reduce the number of calls or wait a few seconds before resuming calls.