Інтеграції та 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 на день; копії електронною поштою. |
| Передати маршрути у вашу систему | Експорт маршрутів у 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 активних ключів на компанію й до 5 000 записів в одному переліку вмісту папки.
API звітів і push-API
Для інструментів звітності й конекторів ERP окремий API за адресою api-users.optiroutes.com надає дані вашої компанії у вигляді звітів і приймає передані дані. Одна адреса й один токен, виданий OptiRoutes для вашої компанії, охоплюють усі виклики. На сторінці документації можна вставити свій токен і побачити, які звіти вам доступні, а також зіставлення стовпців вашого акаунта: читати документацію API.
| Звіт | Що повертає |
|---|---|
| orders | Замовлення й доставки з маршрутом і водієм. |
| routes | Маршрути з водієм і кількістю зупинок. |
| drivers | Дані водіїв. |
| customers | Дані клієнтів і адреси. |
| pod | Документація доставок. |
| delivery-summary | Щоденний підсумок за статусами. |
Два push-виклики працюють у зворотному напрямку: передавання замовлень записує файл замовлень дня й запускає автоматичне завантаження, а передавання водіїв, ліній і транспортних засобів замінює весь автопарк, як файл автопарку. Оскільки переданий список водіїв вважається повним автопарком, завжди надсилайте всіх водіїв, а не лише зміни.
Експорт маршрутів і вебхуки
Експорт маршрутів записує позначені маршрути у CSV, XLSX, XML, JSON або TXT із фіксованою шириною полів. Таблиця стовпців визначає, які поля виходять і під якими заголовками, можна додавати вихідні стовпці вашого файлу замовлень, а з керуванням товарами другий файл перелічує кожну позицію. Експорт може йти на ваш комп’ютер, ваш FTP-сервер або в папку компанії, а у форматі JSON його також можна надсилати на вебадресу; якщо надсилання не вдалося, система пробує ще раз.
Щоб отримувати кожну доставку в момент виконання, заповніть адресу для звітів про доставки в налаштуваннях застосунку водія: кожен звіт про доставку, який роблять водії, надсилається й туди, тож інша ваша система оновлюється сама.
Електронна пошта, платежі, карти й повідомлення
- Електронна пошта — підписані накладні надсилаються з вашого власного акаунта Gmail за допомогою пароля застосунку Google; звіти, як-от звіт про піддони наприкінці дня, надходять на вашу пошту для звітів; клієнти, які оплатили, отримують квитанції, а водії — підтвердження здачі коштів із каси.
- Платежі — поповнення оплачуються на захищеній платіжній сторінці 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. Копія також надсилається електронною поштою за вашими правилами розсилання.
Хто створює ключі для Files API?
Керівник компанії — у розділі «Налаштування», «API і файли». Ключі мають дозволи, необов’язкові дозволені адреси й строк дії, і їх можна будь-коли відкликати.
Чи є API для звітів?
Так. API звітів повертає замовлення, маршрути, водіїв, клієнтів, POD і щоденний підсумок доставок — з токеном, виданим OptiRoutes.
У яких форматах можна експортувати маршрути?
CSV, XLSX, XML, JSON і TXT із фіксованою шириною полів — з обраними вами стовпцями й заголовками.
Спробувати безкоштовно — 3 дні, без картки
3 дні безкоштовно · до 50 адрес на день · без кредитної картки