Packing API

Rychlý start

1. Přihlaste se → klikněte na své jméno → API → vygenerujte klíč.
2. Odešlete požadavek na zabalení (tento běží v pískovišti — zdarma na každém tarifu):

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-..."
}

Dotazujte se na status_url (se stejným autentizačním záhlavím), dokud není 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/..."
  }
}

Endpointy

Pole odpovědi

Objekt result u dokončené úlohy:

Verzování a stabilita

Kontrakt je verzován v cestě (/api/v1/). V rámci v1 jsou změny pouze přídavné — nové volitelné pole požadavku, nová pole odpovědi, nové kódy vozidel a chybové kódy se mohou objevit a klienti by měli ignorovat pole, která neznají. Stávající pole nikdy nemění význam ani typ a nic není odstraněno. Změna narušující kompatibilitu znamená novou verzi cesty, přičemž v1 je udržována paralelně po dobu nejméně 12 měsíců a oznámení o vyřazení je zasláno e-mailem každému pracovnímu prostoru s aktivním klíčem.

Pole požadavku

Pole položek

Kódy vozidel

Generováno z aktuálních specifikací enginu. Vlastní vozidla z vaší pracovní flotily fungují přes custom_vehicle_id.

Nákladní vozy a návěsy

Kontejnery

Úrovně přístupu a limity

Do limitu se započítávají pouze úspěšně dokončené plány — neúspěšné validace a neprovedené úlohy se nezapočítávají. Obě čítače se resetují 1. dne v měsíci (UTC). Výsledky v sandboxu jsou kompletní a neomezené — limity slouží jako brána, nikoli jako omezení výstupu. Potřebujete více než 5 000 plánů měsíčně? Obraťte se na nás ohledně objemových a OEM cen.

Webhooky

Zadejte callback_url, abyste po dokončení úlohy obdrželi výsledek pomocí POST. Každý callback obsahuje X-Hansatic-Signature: HMAC-SHA256 těla zprávy s webhook tajemstvím vašeho klíče (zobrazeno pouze při vytváření klíče). Ověřte ji:

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));
}

Doručení probíhá jedním pokusem s časovým limitem 5 s — status_url zůstává vždy zdrojem pravdy.

Chyby

Všechny chyby mají { "error": { "code", "message", ... } } — strojově čitelný kód, srozumitelnou zprávu a field, pokud je chyba způsobena konkrétním vstupním polem.