Get started with the API

Get your API credentials

Only Owners and Admins can create and manage API keys. If you don't have Admin rights, ask an account Owner or Admin to complete this step, or to grant you those rights first.

1. Access and login into your Dashboard.
2. Open the API tab.
3. Create a key with a name and a role (the role determines its access rights).
4. Copy the API key and API password using the clipboard icon next to it.

You can edit, re-role, or delete a key later from the same API tab.

Retrieve a bearer token

The Plytix API uses bearer token authentication. You don't send your API key and password on every request. Instead, you exchange them once for a token, then send that token instead.

Send a POST request to the /auth/api/get-token endpoint to retrieve your bearer token.

curl --request POST \
  --url https://auth.plytix.com/auth/api/get-token \
  --header 'Content-Type: application/json' \
  --data '{
    "api_key": "your.api.key",
    "api_password": "your.secret.api.password"
  }'

You will receive a bearer token in the response. Every request you make after that needs the Authorization: Bearer <token> header.

Validate connection

With a valid token, perform a GET request to the /products endpoint to confirm your connection is working:

curl --request GET \
  --url https://pim.plytix.com/api/v3/products \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json'

A successful response confirms your entire setup:

• Your API key and password are valid.
• Your bearer token exchange worked.
• Your request headers are correctly formatted.

If you get an error instead, check Status codes and error codes for troubleshooting guidance.