Skip to main content

​
At a glance

  • Availability: Experimental (how to enable).
  • Authentication: API key.
  • Connection: The key from XENTRAL_API_TOKEN is sent as the Bearer prefixed Authorization header.
  • Provider documentation: Authentication reference.

​
Credentials

Set these per environment. See Connect an integration.

​
Setup

  1. Get a Xentral instance: Sign up for a Xentral trial at https://xentral.com. Your instance gets its own host like mycompany.xentral.biz. All API calls go to that host.
  2. Create a Personal Access Token: In your Xentral instance, create a Personal Access Token (PAT) via the API token settings (see https://help.xentral.com/hc/en-us/articles/22627542067740). Grant read scopes for sales orders, products, and customers, plus create scope for sales orders if you want to import orders.
  3. Store the token: Add XENTRAL_API_TOKEN to your .env file. It is sent as an Authorization: Bearer header on every request.
  4. Verify access: Set XENTRAL_INSTANCE_HOST to your instance host (e.g. mycompany.xentral.biz), then run the List Sales Orders tool.

​
Provider notes

  • Every tool sends its requests to the XENTRAL_INSTANCE_HOST environment variable: your instance subdomain such as mycompany.xentral.biz (custom domains are also supported)
  • PAT scopes are granted per resource group (CRM, products, accounting, …) with separate read/create/update/delete permissions
  • Sales orders use the v1 API; products and customers use the newer v2 API endpoints
  • List responses wrap results in a data array with pagination info in extra
Provider API reference.

​
Tools

​
Verify the connection

Call a read tool such as xentral__list_sales_orders with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.