Интеграции и API
OptiRoutes подключается к системам, которыми вы уже пользуетесь. Заказы поступают из файла Excel или CSV, по FTP или SFTP или через защищенный Files API; подписанные накладные, выгрузки маршрутов и отчеты возвращаются тем же путем. API отчетов передает ваши данные в BI-инструменты, а веб-адреса получают отчеты о доставке и выгрузки маршрутов в момент их появления.
Обновлено:
Какие интеграции предлагает OptiRoutes?
| Задача | Как это делает OptiRoutes |
|---|---|
| Загрузить заказы дня | Загрузка Excel или CSV, автоматическая загрузка по FTP, SFTP или через Files API — в формате CSV, JSON или TXT с фиксированной шириной полей. |
| Получить подписанные POD | Вызовы Files API по дню или по заказу либо один ZIP за день; копии по e-mail. |
| Передать маршруты в вашу систему | Экспорт маршрутов в CSV, XLSX, XML, JSON или TXT — в файл, на ваш FTP, в папку компании или по веб-адресу. |
| Отчетность в BI или ERP | API отчетов: заказы, маршруты, водители, клиенты, POD и ежедневная сводка доставок. |
| Реагировать на каждую доставку | Адрес для отчетов о доставке, который получает каждый отчет в момент его создания. |
| Оплатить сервис | Stripe Checkout для предоплаченных пополнений и автопополнения. |
Загрузка заказов из файла, по FTP или SFTP
Самая простая интеграция — файл, который ваша система уже выгружает. На экране заказов кнопка «Загрузить доставки» читает файл Excel или CSV; вы один раз сопоставляете каждое поле системы — адрес, имя клиента, номер заказа, количество и так далее — с названием своего столбца, и каждый следующий файл загружается так же. Для файла TXT с фиксированной шириной полей вместо названий столбцов указываются позиции символов. Строки можно пропускать по слову-маркеру в примечаниях, второй маркер может заменять адрес, а вы решаете, обновляется ли существующий номер заказа или добавляется как новый.
Чтобы исключить ручной труд, выберите в настройках способ автоматической загрузки:
- Файловый сервер OptiRoutes — ваша система кладет ежедневный файл с датой в названии в папку вашей компании на FTP-сервере или на зашифрованном SFTP-сервере.
- Ваш собственный FTP-сервер — OptiRoutes подключается с указанным вами пользователем и загружает файл с сегодняшней датой в названии или последний обновленный файл.
- Автоматический импорт и экспорт — заказы загружаются сами, и маршруты тоже планируются без единого щелчка.
- Files API — ваше ПО загружает файл заказов по HTTPS, как описано ниже.
На экране клиентов файл Excel или CSV с номером клиента, названием, адресом, временем остановки и временем открытия и закрытия создает или обновляет клиентов и их временные окна.
Files API: заказы — внутрь, POD и отчеты — наружу
У каждой компании в OptiRoutes есть своя закрытая папка файлов: загружаемые заказы, подписанные накладные с фото и подписями, выгрузки маршрутов и отчеты за день. Files API позволяет вашим системам читать и записывать эту папку напрямую по HTTPS, без промежуточного FTP-сервера. Менеджер компании переключается между FTP и API в разделе «Настройки» → «API и файлы» и там же создает ключи — обращаться в поддержку не нужно, а новые компании сразу начинают с API.
| Папка | Что в ней | Кто записывает |
|---|---|---|
| orders_files/ | Ежедневный файл заказов и выгрузки маршрутов. | Вы (заказы), OptiRoutes (выгрузки) |
| pod/YYYY/MM/DD/ | Подписанные POD за этот день: подписанный PDF, подпись и фото. | OptiRoutes |
| pod/ | Исходные накладные для подписания в приложении водителя, по одному PDF на номер заказа. | Вы |
| reports/YYYY/MM/ | Отчеты за день и отчеты по возвратам. | OptiRoutes |
| podBaseFile/ | Базовая форма POD. | Вы |
| inbox/ | Свободная папка для файлов, которые вы хотите передать. | Вы |
Вызовы охватывают проверку ключа, получение списка файлов папки, скачивание, загрузку (до 50 МБ на файл) и удаление загруженных вами файлов, получение списка файлов POD за день по заказу и виду и скачивание всех файлов POD за день одним ZIP-архивом. Руководство содержит примеры кода на Python, C# и Node.js, а также скрипт PowerShell, который синхронизирует папку на вашем сервере с папкой компании, — так команда, привыкшая к FTP, может работать по-прежнему. Читайте руководство по Files API.
Как защищены ключи API?
- Минимальные привилегии — каждый ключ получает только необходимые разрешения: только подписанные POD, чтение всех файлов или загрузка заказов и файлов во inbox.
- Разрешенные адреса — ключ можно ограничить фиксированными IP-адресами вашего сервера.
- Срок действия и ротация — ключ может истекать через заданное число дней; создайте новый ключ, переключитесь, затем отзовите старый — без простоя.
- Мгновенный отзыв — отозванный ключ перестает работать в течение 30 секунд.
- Аудит — каждый вызов записывается в журнал со временем, адресом, файлом и ответом и показывается менеджеру.
- Безопасное хранение — OptiRoutes хранит только отпечаток SHA-256 каждого ключа; соединения идут по HTTPS с TLS 1.2 или новее, и ключ имеет доступ только к папке своей компании.
Ограничения: 300 запросов в минуту на ключ, 50 МБ на файл, 20 активных ключей на компанию и до 5000 записей в одном списке файлов папки.
API отчетов и передачи данных
Для инструментов отчетности и коннекторов ERP отдельный API по адресу api-users.optiroutes.com предоставляет данные вашей компании в виде отчетов и принимает передаваемые данные. Один адрес и один токен, выданный OptiRoutes для вашей компании, охватывают все вызовы. На странице документации можно вставить свой токен и увидеть, какие отчеты вам доступны и как сопоставлены столбцы в вашем аккаунте: документация API.
| Отчет | Что он возвращает |
|---|---|
| orders | Заказы и доставки с маршрутом и водителем. |
| routes | Маршруты с водителем и числом остановок. |
| drivers | Данные водителей. |
| customers | Данные и адреса клиентов. |
| pod | Документация доставки. |
| delivery-summary | Ежедневная сводка по статусам. |
Два вызова передачи данных работают в обратном направлении: передача заказов записывает файл заказов дня и запускает автоматическую загрузку, а передача водителей, линий и транспорта заменяет весь автопарк, как файл автопарка. Поскольку переданный список водителей считается полным автопарком, всегда отправляйте всех водителей, а не только изменения.
Экспорт маршрутов и вебхуки
Экспорт маршрутов записывает отмеченные маршруты в CSV, XLSX, XML, JSON или TXT с фиксированной шириной полей. Таблица столбцов определяет, какие поля выгружаются и под какими заголовками, можно добавить исходные столбцы вашего файла заказов, а при управлении товарами второй файл перечисляет все товары. Выгрузки могут сохраняться на ваш компьютер, на ваш FTP-сервер или в папку компании, а в формате JSON выгрузку можно также отправлять по веб-адресу; если отправка не удалась, система пробует еще раз.
Чтобы получать каждую доставку в момент ее выполнения, заполните адрес для отчетов о доставке в настройках приложения водителя: каждый отчет о доставке, который делают водители, будет отправляться и туда, так что другая ваша система обновится сама.
E-mail, платежи, карты и сообщения
- E-mail — подписанные накладные отправляются с вашего собственного аккаунта Gmail с паролем приложения Google; отчеты, например отчет по поддонам за день, приходят на ваш e-mail для отчетов; касса отправляет плательщикам квитанции, а водителям — подтверждения сдачи денег.
- Платежи — пополнения оплачиваются на защищенной странице оплаты Stripe, по желанию с сохраненной картой для автопополнения.
- Адреса и карты — адреса выбираются из подсказок Google и проверяются на карте до планирования.
- Навигация — приложение водителя передает каждую остановку в Waze или в Apple Maps на iPhone, по адресу или по точным координатам.
- SMS и WhatsApp — сообщения о прибытии и ссылки для отслеживания клиентам, уведомления менеджерам, линии подрядчикам и изображения маршрутов водителям в WhatsApp.
Планируете интеграцию с вашей ERP или складской системой? Расскажите нам, что нужно подключить.
3 дня бесплатно · до 50 адресов в день · без банковской карты
Часто задаваемые вопросы
Может ли OptiRoutes автоматически загружать заказы из нашей ERP?
Да. Ваша ERP может класть ежедневный файл на FTP- или SFTP-сервер OptiRoutes, на ваш собственный FTP-сервер или загружать его через Files API, а OptiRoutes загрузит его сам.
Как получить подписанные POD в нашу систему?
Через Files API: получите список и скачайте файлы POD за день или скачайте их все одним ZIP-архивом. Копия также отправляется по e-mail согласно вашим правилам рассылки.
Кто создает ключи для Files API?
Менеджер компании — в разделе «Настройки» → «API и файлы». У ключей есть разрешения, необязательные разрешенные адреса и срок действия, и их можно отозвать в любой момент.
Есть ли API для отчетов?
Да. API отчетов возвращает заказы, маршруты, водителей, клиентов, POD и ежедневную сводку доставок по токену, выданному OptiRoutes.
В каких форматах можно экспортировать маршруты?
CSV, XLSX, XML, JSON и TXT с фиксированной шириной полей — с выбранными вами столбцами и заголовками.
Начать бесплатно — 3 дня, без карты
3 дня бесплатно · до 50 адресов в день · без банковской карты