Zakeke uses cookies to provide necessary site functionality and improve your experience. By using our website, you agree to our privacy policy and our cookie policy.   

API Reference

Authentication and authorization

For all API requests you will need to authenticate your store.

The Zakeke REST API uses the OAuth 2.0 protocol to authorize calls. OAuth is an open standard that many companies use to provide secure access to protected resources.

When you create an API Key, Zakeke generates a set of OAuth client ID and secret credentials for your Merchant Web Site for live environment. You pass these credentials in the Authorization header in a get access token request.

In exchange for these credentials, the Zakeke authorization server issues access tokens called bearer tokens that you use for authorization when you make REST API requests. A bearer token enables you to complete actions on behalf of, and with the approval of, the resource owner.

The Access-Token field in the get access token response contains a bearer token, indicated by the token_type of Bearer:

{
    "access-token": Your-Access-Token,
    "token_type": "Bearer",
    "expires_in": 32398
}

Include this bearer token in API requests in the Authorization header with the Bearer authentication scheme.

This sample request uses a bearer token to list invoices for a merchant:

curl -v -X GET https:/api.zakeke.com/v1/designs/000-2p5ysDc6d0mC6FQXL0BHXA \
     -H "Content-Type:application/json" \
     -H "Authorization: Bearer <Access-Token>"

Access tokens have a finite lifetime. The expires_in field in the get access token response indicates the lifetime, in seconds, of the access token. For example, an expiry value of 3600 indicates that the access token expires in one hour from the time the response was generated.

To detect when an access token expires, write code to either:

Before you create another token, re-use the access token until it expires.

Get an access token

The get access token endpoint is https://api.zakeke.com/token.

To get an access token, you pass your OAuth credentials in a get access token call. To make this call, you can use either cURL on the command line or the Postman app.

In response, the Zakeke authorization server issues an access token.

Re-use the access token until it expires. When it expires, you can get a new token.

N.B. OAuth tokens will be CLIENT-SERVER to default, so they can only be used for CLIENT-SERVER requests. For SERVER to SERVER requests to the endpoint, you need a S2S token for authentication.

cURL example

Tips:

  • If you use Windows, use a Bash shell to make cURL calls.
  • If you use a command-line tool other than cURL, set content-type to application/x-www-form-urlencoded.
  1. Download cURL for your environment.

  2. From the command line, run this command:

    curl -X POST https://api.zakeke.com/token \
         -H "Accept: application/json" \
         -u "your_client_id:your_secret_key" \
         -d "grant_type=client_credentials"

    Where:

    https://api.zakeke.com/token The get access token endpoint.
    client_id Your client ID.
    secret Your secret key.
    grant_type The grant type. Set to client_credentials.
  3. View the sample response.

Postman example

  1. Download Postman for your environment, and open Postman.

  2. On the Authorization tab, select or enter this information:

    Method POST
    Endpoint https://api.zakeke.com/token
    Username Your client ID.
    Password Your secret key.
  3. On the Body tab, select or enter this information:

    Content type x-www-form-urlencoded
    key grant_type
    value client_credentials
  4. Click Send.

  5. View the sample response.

Sample response JSON

{
    "Access-Token": "Access-Token",
    "token_type": "Bearer",
    "expires_in": 32398
}

Where:

Access-Token Your access token.
expires_in The number of seconds after which the token expires. Request another token when the current one expires.

Access token for S2S endpoint requests

For Server to Server (S2S) requests to the various endpoints the authentication OAuth token must be S2S.

The way to get an authentication OAuth token S2S is the same as normal request except that, in addition of OAuth credential, you must sent the parameter access_type set on S2S mode:

cURL example

Tips:

  • If you use Windows, use a Bash shell to make cURL calls.
  • If you use a command-line tool other than cURL, set content-type to application/x-www-form-urlencoded.
  1. From the command line, run this command:

    curl -X POST https://api.zakeke.com/token \
         -H "Accept: application/json" \
         -H "Content-Type: application/x-www-form-urlencoded" \
         -u "your_client_id:your_secret_key" \
         -d "grant_type=client_credentials" \
         -d "access_type=S2S"
            

Customer code and Visitor code into access token

Some endpoints (es. such as order checkout on Zakeke: https://api.version.com/v1/order) require an autentication token with, in addition to your OAuth credentials, the visitor ID and / or user ID logged.

One or both of these parameters have to be sent to the token request:

Name Data type Description
visitorcode string Identifier of visitor who is browsing on your store
customercode string Identifier of user who is logged on your store

cURL example (Request for OAuth S2S token with user and customer code)

Tips:

  • If you use Windows, use a Bash shell to make cURL calls.
  • If you use a command-line tool other than cURL, set content-type to application/x-www-form-urlencoded.
  1. From the command line, run this command:

    curl -X POST https://api.zakeke.com/token \
         -H "Accept: application/json" \
         -H "Content-Type: application/x-www-form-urlencoded" \
         -u "your_client_id:your_secret_key" \
         -d "grant_type=client_credentials" \
         -d "access_type=S2S" \
         -d "visitorcode=VISITOR_CODE" \
         -d "customercode=CUSTOMER_CODE"