DoctorX logoDoctorX Get an API key

DoctorX Public API

Version 1.0.0

The DoctorX Public API lets an external system manage a seller's marketplace catalog and orders across TikTok Shop, eBay, Etsy and Amazon.

Base URL

https://api.doctorx.vn/api/public/v1

Get an API key

  1. Sign in to the DoctorX dashboard as an admin of the workspace. Keys belong to one workspace, and only its admins can create them. The workspace's plan must include the Developer API; below it, every request is refused with plan_upgrade_required.
  2. Open Settings → Integrations → API keys and choose Create key.
  3. Select only the scopes your integration needs (see Scopes). You can also limit the key to some shops, give it an expiry, and register a webhook endpoint in the same step.
  4. Copy the key when it is shown. It is shown once: a lost key is rotated, never recovered.
Open Settings → Integrations → API keys

Make your first request

Export the key as DOCTORX_API_KEY, then list the shops it can reach (the key needs the authorize:read scope): List connected shops.

curl -X GET 'https://api.doctorx.vn/api/public/v1/authorize/shops' \
  -H "Authorization: Bearer $DOCTORX_API_KEY"

API reference