العربية

Developers: API keys and webhooks

Connect your store to a POS, ERP, shipping company or your own app with API keys and real-time notifications.

Open this page in your dashboard

The Developers page is for connecting your store to other software. Only the store owner can manage it. At the top you'll find the API base URL, the Auth header and an API docs button that opens the full reference for every endpoint.

The Developers page
The Developers page

Create an API key

  1. Click Create key.
    The new key window
    The new key window
  2. Enter a Key name that reminds you who it's for (like "Front-counter POS").
  3. Choose Permissions for each type of data: Products, Orders, Customers, Inventory and Fulfillments (read only, or read & write). Grant as little as you can.
  4. Click Create key, then copy it right away and store it somewhere safe.

Your software sends the key with every request in the header: Authorization: Bearer apx_…

The key is shown only once. If you lose it, create a new one. If it leaks, click Revoke and access stops immediately.

Each key works for this store only. Limits: a burst of 40 requests and 2 requests per second per key. Each key shows when it was created and last used.

Webhooks: real-time notifications

We send a notification to your URL the moment something happens in your store.

  1. Click Add webhook.
  2. Enter the Endpoint URL (it must start with https://).
  3. Pick the Events: order created, updated, canceled or paid; product created, updated or deleted; customer created; or fulfillment updated.
  4. Click Add.

Every notification is signed with the Signing secret shown on the webhook's card, in the X-Apexfy-Hmac-Sha256 header. Verify it in your app before trusting the notification. You can Pause any webhook or delete it.

Recent deliveries

The bottom of the page lists the last 30 notifications we sent and the status of each: sent, pending or failed. If your URL doesn't respond, we retry automatically and show when the next attempt is.

To connect a carrier or accounting software, ask your developer to start with the API docs; every endpoint there comes with ready examples.
Was this guide helpful?