Zyllem Developer Portal

Zyllem Developer Portal

Welcome! This site presents a guide on how to integrate with Zyllem so you can directly manage delivery orders.

Documentation     Support

Authorization 101

All you need to know about Zyllem API authorization

The Zyllem API uses API keys to control the access rights of applications that connect to it.

To obtain authorization, generate at least one API keys on the web portal. Then, attach the API key as a query parameter named key to all your calls to the API.

You may use the /ping resource to test your connectivity.

GET /api/ping?key=my-api-key HTTP/1.1
Host: yourEnterprise.zyllem.com
Content-Type: application/json
curl -X GET \
  'https://yourEnterprise.zyllem.com/api/ping?key=my-api-key' \
  -H 'content-type: application/json'

Ping

Use this resource to test the connectivity between your application and the Zyllem API. This simply returns a message addressed to your API client.

URL: GET https://{yourEnterprise}.zyllem.com/api/ping
Sample Response:

{
    "message": "Hello API Client"
}
{
    "message": "Invalid API key"
}
{
    "message": "The requested resource does not support http method 'POST'."
}

Authorization 101


All you need to know about Zyllem API authorization

Suggested Edits are limited on API Reference Pages

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