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. You can access the routing workspace with this username.
  4. You have an OAuth token for your app from the same username.
  5. You created at least one depot through the routing workspace or API.

    You can see if there's a depot under Settings → Depots in the routing workspace.

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

    You can check courier data 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. Order availability can be checked on the main page or in the Orders section.

  8. You 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 list of added phone numbers is available under Settings → Couriers in the routing workspace.

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

    When using GPS trackers

    1. You set up data transfer from the GPS tracker to Yandex servers over the EGTS protocol.
    2. You set up the transfer of the GPS tracker's number 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 being delivered and information on them is available in the routing workspace.

Contact support