Packing API

Швидкий старт

1. Увійдіть → натисніть на своє ім'я → API → згенеруйте ключ.
2. Надішліть завдання на пакування (це завдання виконується в пісочниці — безкоштовно на кожному тарифі):

curl -X POST https://hansatic.com/api/v1/pack \
  -H "Authorization: Bearer hk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "vehicle": "CURTAINSIDER_136",
    "objective": "ldm",
    "sandbox": true,
    "items": [{
      "name": "Machine crate",
      "length": 2300, "width": 750, "height": 1400,
      "weight": 300, "quantity": 7,
      "stackable": false, "tiltable": false
    }]
  }'

{
  "job_id": "5e3617d1-abe4-4549-b7e6-d18c6baf814f",
  "status": "queued",
  "sandbox": true,
  "status_url": "https://hansatic.com/api/v1/jobs/5e3617d1-..."
}

Запитуйте status_url (з тим самим заголовком автентифікації), доки status не стане "done":

{
  "job_id": "5e3617d1-...",
  "status": "done",
  "result": {
    "placed_count": 7,
    "unplaced_count": 0,
    "units": "metric",
    "metrics": {
      "ldm_m": 5.25,
      "span_mm": 5250,
      "linear_ft": 17.2,
      "pallet_positions_eur": 14,
      "total_weight_kg": 2100,
      "overlaps": 0
    },
    "items": [
      { "id": "...", "name": "Machine crate", "placed": true,
        "x": 8370, "y": 0, "z": 0,
        "rotation_deg": 90, "tilt_deg": 0, "...": "..." }
    ],
    "plan_url": "https://hansatic.com/en/app/plans/..."
  }
}

Ендпоінти

Поля відповіді

Об'єкт result у завершеному завданні:

Версіонування та стабільність

Контракт версіонується в шляху (/api/v1/). У межах v1 зміни лише додаткові — нові необов'язкові поля запиту, нові поля відповіді, нові коди транспортних засобів та коди помилок можуть з'являтися, а клієнти повинні ігнорувати поля, які не розпізнають. Існуючі поля ніколи не змінюють значення або тип, і нічого не видаляється. Зміни, що порушують сумісність, означають новий шлях версії, при цьому v1 підтримується паралельно щонайменше 12 місяців, а про застарення повідомляється електронною поштою кожному робочому простору з активним ключем.

Поля запиту

Поля предметів

Коди транспортних засобів

Згенеровані на основі актуальних специфікацій движка. Кастомні транспортні засоби з вашого парку працюють через custom_vehicle_id.

Вантажівки та причепи

Контейнери

Рівні доступу та обмеження

До ліміту зараховуються лише успішно виконані пакування — невдалі валідації та завдання не враховуються. Обидва лічильники скидаються 1-го числа (UTC). Результати в пісочниці є повними та без обмежень — ліміти стосуються лише кількості запитів, а не якості виводу. Потрібно більше 5 000 пакувань на місяць? Зверніться до нас щодо оптових та OEM-пропозицій.

Вебхуки

Передайте callback_url, щоб отримати результат POST-запитом після завершення завдання. Кожен вебхук містить X-Hansatic-Signature: HMAC-SHA256 від сирого тіла з вебхук-секретом вашого ключа (показується один раз при створенні ключа). Перевірте його:

const crypto = require('crypto');

function verify(rawBody, signatureHeader, webhookSecret) {
  const expected = crypto.createHmac('sha256', webhookSecret)
    .update(rawBody).digest('hex');
  return crypto.timingSafeEqual(
    Buffer.from(expected), Buffer.from(signatureHeader));
}

Доставка здійснюється одним запитом з тайм-аутом 5 с — status_url завжди залишається джерелом істини.

Помилки

Усі помилки мають { "error": { "code", "message", ... } } — машинозчитуваний код, зрозуміле повідомлення та field, якщо помилка стосується конкретного поля введення.