Checklist for implementing the API

Implementing an API is a complex process that involves a lot of people. To make it easier, use the following checklist:

  1. You have a company ID. The company ID is a number, such as 410.
  2. You have a Yandex ID username.
  3. This username has access to the routing workspace.
  4. Using this username, you got an OAuth token for your app.
  5. You created at least one depot via the routing workspace or the API.

    To check whether a depot was created, go to Settings → Depots in the routing workspace.

  6. You set up exporting courier data using the API. If couriers change often, data should be exported on a regular basis. If they don't, exporting data just once is fine.

    You can check the courier information in the Couriers section of the routing workspace.

  7. You configured regularly route generation for the day and adding orders.

    You can check route availability for any date on the main page of the routing workspace. To see if there are any orders planned for that date, go to the main page or the Orders section.

  8. You have set up transfer of actual data:

    When using the Yandex Courier app

    1. You added the phone numbers of couriers allowed to use the Yandex Courier app to the database.

      The phone numbers are available on the Settings → Couriers page of the routing workspace.

    2. The couriers installed the Yandex Courier app on their smartphones.
    3. The couriers watched the app video tutorials.
    4. The couriers use the app correctly and mark deliveries.

    When using GPS trackers

    1. You configured data transfer from GPS devices to Yandex servers using the EGTS protocol.
    2. You set up IMEI transfer for routes for the day.

    If configured correctly, information about the courier's GPS tracker will be available for routes in the routing workspace.

  9. Your orders are delivered, and order information is available in the routing workspace.

Contact support