Zyllem Developer Portal

Zyllem Developer Portal

Welcome! This site presents a guide on how you can integrate with Zyllem and manage your bookings with us.

Documentation     Support

Getting Started

A quick guide to get your first integration running

1. Log in to your account

Log in to your enterprise web portal (e.g., example.zyllem.com).

Both your enterprise web portal address and your login credentials are provided by your administrator.

2. Register your application

Application is also referred to as Client in your enterprise web portal.

2.1 Go to /Settings/API Clients.
2.2 Click Add Client to add your application.

Don't see API Clients?

Contact your administrator to grant you access to API Clients. If you can see /Settings/Users and /Roles, you can grant yourself access by adding and assigning a role to your user account.

2.3 Fill in the application details and click Save.

Field
Description

Name

Your application name

Description

(Optional) Description of your application

Network

All orders booked via the API will reflect on this network. On the Items page, this appears as Ordered on Network: this network

User

All orders booked via the API will reflect on this user. On the Items page, this appears as Ordered by: this user

Once your application is added, it will be listed on the API CLIENTS TABLE.

3. Generate your API key

3.1 Click on the application name you registered in Step 2.
3.2 Under KEY TABLE SECTION, click Add Key.
3.3 Fill in the key name and description (optional), and click Save.

Once the key is generated, it will be listed on the KEY TABLE.

Using the API key

The API key is used to authorize your connection to the Zyllem API. You need to attach it as a query parameter named key to all your calls to the API. You can generate multiple API keys and revoke them. See Authorization 101.

4. Call the API

Test the integration by using /ping endpoint.

Once you get a successful ping response, you are ready to book your first delivery order.

Getting Started


A quick guide to get your first integration running

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.