API Tokens

The API Tokens page lets you generate and manage your own access tokens to use the Quable PIM API.

⚠️

Important: Quable PIM displays the plain-text token only once, right after it is created. Copy it and store it somewhere safe: you cannot retrieve it once this window is closed.

API token list

Prerequisites

  1. Open the API Tokens page in Quable PIM.
  2. Make sure you have access to token management. Administrators have access by default.

Access levels

Two access levels are available when creating a token:

Read access (read)

Grants limited, read-only access to the Quable PIM API. This token does not allow you to add, update or delete content.

Supported HTTP methods: GET

Read/Write access (read_write)

Grants full, unrestricted access to the Quable PIM API. This token gives access to all Quable PIM features.

Supported HTTP methods: GET POST PUT DELETE

💡

Administrators have access to token management by default.


Create a token

  1. Click Create token on the management page.
  2. Fill in the following fields:
    • Name (required) — A descriptive name to identify the token, e.g. My application.
    • Access level (required) — Read (read) or Read/Write (read_write).
    • Expiration (required) — Choose from: 1 day, 1 week, 1 month, 3 months, 6 months, 1 year, or no expiration.
API token creation
  1. Click Create.
  2. Copy the displayed token immediately. Once this window is closed, you can no longer view it.
Generated API token

Manage your tokens

The list displays all your tokens with the following information:

ColumnDescription
NameThe name you gave the token
Creation dateThe date the token was created
Access levelRead (read) or Read/Write (read_write)
ExpirationThe expiration date, or Never
StatusActive, Expired or Revoked

Revoke a token

You can only revoke tokens with the Active status.

  1. Click the revoke icon on the row of the token you want to revoke.
  2. In the confirmation window, type REVOKE to confirm.
Revoke a token
  1. Click Revoke.
⚠️

Revocation is permanent: it immediately invalidates the token, which you cannot reactivate.


Token statuses

StatusDescription
ActiveThe token is valid: you can use it
ExpiredThe expiration date has passed
RevokedThe token has been revoked

Use a token

Once copied, add the token to the Authorization HTTP header of your requests:

Authorization: Bearer your_token

The base URL of the Quable PIM API is your Quable PIM URL followed by /api (e.g. https://example.quable.com/api).

To test it from the interactive API documentation:

  1. Open the API documentation and click the Authorize button.
  2. In the Value field, enter Bearer followed by your token.
  3. Click Authorize to activate the session.
💡

Don't forget to type the Bearer keyword followed by a space before your token.

Troubleshooting

  • If your request fails, check that the Authorization header contains Bearer followed by a space and the token you copied when it was created.
  • If the token is Expired or Revoked, create a new token: a revoked token cannot be reactivated.
  • If an add, update or delete operation fails with a Read (read) token, use a Read/Write (read_write) token instead.

Did this page help you?