Your Guide to ZIM [API]

Welcome to ZIM [API]. To get started, just follow the steps below:

1. Creating your ZIM [API] Account: First, sign up to create your free account and get user access to ZIMAPI products. Once your account has been set up, you can use your new details to register.

2. Request Subscription: To request an API product subscription, go to the “API Products” tab from the Main Menu. Select your required API product and click Subscribe. Each product subscription requires separate approval and will be added into your user profile or listed under “Subscriptions” on the API Products page.

3. Receive Approval for Sandbox APIs: If you would like to use a trial version of our API products, subscribe to the “Sandbox Products” which are available for trial on the “API Products” page and are approved automatically, without Client-ID and Secret Value.

If you wish to use Sandbox products elsewhere, you can find their relevant Client-ID and Secret Value in the product’s description. Please note, Sandbox products have limited request attempts, and are not for production use.

Other API product subscriptions are approved by ZIM and available for production use. Following approval, you will receive two separate email notifications with your Client-ID and Secret Value details, which can then be applied to start using your API products.

4. Use APIs: The APIs have global access and are limited to a number of requests per minute (each user is limited to 10 concurrent call attempts for all API products) and according to each product’s contract.

The API authentication process relies on the OAuth 2.0 standard with “Client Credentials” flow (more information about the OAuth 2.0 protocol can be found online) and you can also find two examples below:

Authorization request:

curl --location 'https://apigw.zim.com/authorize/v1' \

--header 'Content-Type: application/x-www-form-urlencoded' \

--data-urlencode 'grant_type=client_credentials' \

--data-urlencode 'client_id={clientID}' \

--data-urlencode 'client_secret={clientPass}' \

--data-urlencode 'scope=tracing'

Where “scope” is taken from the product description page, in this example it is the tracing API.

Tracing request example:

curl --location 'https://apigw.zim.com/tracing/v1/ZIMUNYC983928' \

--header 'Ocp-Apim-Subscription-Key: {susbscriptionKey}' \

--header 'Authorization: bearer {jwt}'

{{jwt}} – should be replaced by the jwt token from the authorize call , token is valid for one hour .

All API product pages include a “Try It” button, although they are only supported by Sandbox Products. After selecting “Try It” on the Sandbox Products page, a pop-up window will be displayed.

The Subscription Key is automatically selected as “Primary”.

In the “Parameters” section, enter the required parameters and click Send.

All API products are accessible from any external platform. Simply get a token using “/authorize”. The token can then be used together with your subscription ID to access all ZIM[API] products.