😎
APIs & Tokens
Explore Zid public APIs

Base URIs

There are two type of URI to use while you are developing apps, the base API url that you will use to consume different type of resources like (orders, products, coupons), the other URI is the base of OAuth2.0 server, which you will use to get your app authenticated on a merchant store as explained in here.
Base API URL
1
https://api.zid.sa/v1
Copied!
Base OAuth server URL
1
https://oauth.zid.sa
Copied!

Tokens

There are two types of token, each of your requests must send along other payloads

Authorization Token

Authorization token can be generated directly through our oAuth2.0 server (once a merchant install your application, you will get this token via the callback method), this token will be used to in your outgoing request as authorization header, here is a sample cURL with access token
Once you are subscribed to a backend, you can now generate either Production keys or Sandbox Keys.
1
curl -X GET "https://api.zid.dev/app/v1/managers/account/profile" -H "accept: application/json" -H "X-MANAGER-TOKEN: {{X-MANAGER-TOKEN}}" -H "Accept-Language: ar" -H "Authorization: Bearer eyJ4NXQiOiJNell4TW1Ga09HWXdNV0kwWldObU5EY3hOR1l3WW1NNFpUQTNNV0kyTkRBelpHUXpOR00wWkdSbE5qSmtPREZrWkRSaU9URmtNV0ZoTXpVMlpHVmxOZyIsImtpZCI6Ik16WXhNb"
Copied!
Some backend require Admin approval on production keys generation.

X-Manager-Token

Unlike the authorization token, the X-Manager-Token can be generated through your store admin panel and via the oAuth2.0 server, this token is used to identify your store to our backend, to generate this token manually you can follow these simple steps:
  1. 1.
    Login to your store admin panel.
  2. 2.
    From your store settings → integrations → Zid, or click here.
  3. 3.
    Now you can generate your X-Manager-Token
Note that some of endpoints does not require X-Manager-Token, however, the authorization token is a must in every single request, to get a better clue, always use Try It feature from our partner dashboard.

Playing with APIs

You can play with all of our APIs endpoints, moreover, all of our apis have a fully documented JSON schema to referee to while building applications, to try out the API, you will need to register your account in the partner dashboard then create your development store, finally you can try out any endpoint from the TryIt tab
Try it area