SAMO·TRANS
Telegram
Документація API

Інтеграція біржі SAMO-TRANS у вашу TMS або CRM

Документація API

Події

Журнал змін

Історія змін публічного API SAMO-TRANS.

Нові записи — згори. Кожна зміна публічного контракту потрапляє сюди.

Про принципи сумісності — Версіонування.

v1.1

  • GET /employees — перелік працівників компанії.
  • GET /employees/{id}/proposals-count — кількість заявок, де працівник є контактною особою.
  • PATCH /employees/{id}/status — увімкнути або тимчасово вимкнути працівника.
  • PATCH /employees/{id} — змінити роль або відображуване ім'я.
  • Нові області доступу employees:read та employees:write. Раніше випущені ключі їх не мають — потрібен новий ключ.
  • Поле contactPersonId тепер приймається при створенні та редагуванні заявки (зокрема в пакетному створенні). Допускаються лише власник компанії та працівники зі статусом ACTIVE.
  • Виправлено: includeInactive у GET /proposals/search раніше сприймав будь-яке непорожнє значення як true — зокрема includeInactive=false повертав і закриті заявки. Тепер параметр читається як записано: true/1/yes/on вмикають, false/0/no/off вимикають, нерозпізнане значення дорівнює відсутньому. Якщо ваша інтеграція надсилала false і розраховувала на закриті заявки, вона отримає інший набір — надсилайте true явно.

v1.0

Перший публічний випуск API.

Довідники

  • GET /reference/countries, /reference/regions — географія.
  • GET /reference/car-types, /load-types, /permits, /currencies, /payment-types — словники кодів із назвами п'ятьма мовами.
  • GET /localities/search — пошук населених пунктів, джерело osmId для маршрутів.

Біржа

  • GET /proposals/search — пошук по всій біржі з фільтрами веб-версії, параметр updatedSince для інкрементальної синхронізації.
  • GET /proposals/{id} — картка заявки.
  • GET /companies/{id}, GET /companies/{id}/reviews — картка контрагента й схвалені відгуки.

Власні заявки

  • POST /proposals/cargo, POST /proposals/transport — створення.
  • POST /proposals/batch — до 25 заявок одним запитом із результатом по кожній позиції.
  • GET /proposals/my — перелік заявок компанії, до якої прив'язаний ключ.
  • PATCH /proposals/{id}, POST /proposals/{id}/bump, /archive, /restore, DELETE /proposals/{id}.

Платформа

  • Аутентифікація ключами samo_live_ з областями доступу reference:read, proposals:read, proposals:write та необов'язковим переліком дозволених IP.
  • Ліміти на ключ із заголовками X-RateLimit-* і сталими кодами rate_limited / quota_exceeded.
  • Заголовок Idempotency-Key для безпечних повторів запитів на запис.
  • Вебхуки proposal.created / updated / deleted та proposal.matched із підписом X-Samo-Signature.
  • Сталий конверт помилки { error: { code, message, requestId } }.