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, если проблема связана с конкретным полем ввода.