Skip to main content

Connecting the system

This section is for developers of external systems — accounting software, ERP, WMS, online shops — connecting to the platform through the public API.

It covers the whole path: issuing a key, uploading orders, starting planning, and receiving finished routes and delivery statuses.

:::note Translation status

The Russian text of this section is complete and authoritative. The English chapters are being translated one at a time; each untranslated chapter links to its Russian counterpart.

Field names, headers, endpoint paths and error messages are identical in both locales — they are quoted verbatim from the API and are never translated.

:::

Where to start​

If you are integrating for the first time, read the first three chapters in order. They take about fifteen minutes and prevent most common mistakes:

  1. Quick start — the four steps of a minimal integration.
  2. Issuing an API key — where to get a key and what not to do with it.
  3. Authentication — which header to send, and why you should not send both.

The remaining chapters are reference material; open them as needed.

Worth reading before you go live​

Two chapters are written from real integration experience and save the most time:

  • Pitfalls — asynchronous geocoding, address formatting, non-unique external_id, and the default delivery date.
  • Limits and errors — rate limiting, response codes, and how to behave after a timeout.

Base address​

Examples use the placeholder address https://api.example.com. Substitute the address of your installation — your company administrator provides it together with the key. Everything after the base address (/api/public/v1/…), along with header and field names, is exact and needs no substitution.