Packing API

Rýchly štart

1. Prihláste sa → kliknite na svoje meno → API → vygenerujte kľúč.
2. Odosielajte požiadavku na zabalenie (táto sa spúšťa v sandboxe – zadarmo na každom pláne):

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

Pýtajte stav na status_url (s rovnakým autentifikačným hlavičkovým riadkom), kým status nie je "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

Polia odpovede

Objekt result po dokončení úlohy:

Verzovanie a stabilita

Zmluva je verzovaná v ceste (/api/v1/). Vo verzii v1 sú zmeny iba pridávacie – nové voliteľné polia požiadavky, nové polia odpovede, nové kódy vozidiel a chybové kódy sa môžu objaviť a klienti by mali ignorovať polia, ktoré nerozpoznajú. Existujúce polia nikdy nemenia význam ani typ a nič sa neodstraňuje. Zmena, ktorá narušuje kompatibilitu, znamená novú verziu cesty, pričom v1 zostáva udržiavaná paralelne najmenej 12 mesiacov a o zrušení sa oznamuje e-mailom každému pracovnému priestoru s aktívnym kľúčom.

Polia požiadavky

Polia položiek

Kódy vozidiel

Generované z aktuálnych špecifikácií enginu. Vlastné vozidlá z vášho pracovného priestoru fungujú cez custom_vehicle_id.

Nákladné vozidlá a prívesy

Kontajnery

Úrovne prístupu a limity

Do limitu sa započítavajú iba úspešné plánovania — zlyhané validácie a neúspešné úlohy sa nezapočítavajú. Obidva počítadlá sa resetujú 1. dňa v mesiaci (UTC). Výsledky v sandboxe sú úplné a neobmedzené — limity sú bránou, nie výstupom. Potrebovali by ste viac ako 5 000 plánovaní mesačne? Kontaktujte nás ohľadom objemových a OEM cien.

Webhooky

Zadajte callback_url, aby ste po dokončení úlohy dostali výsledok pomocou POST. Každý callback obsahuje X-Hansatic-Signature: HMAC-SHA256 podpis tela správy s webhook tajomstvom vášho kľúča (zobrazené iba raz pri vytvorení kľúča). Overte ho:

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čenie sa pokúša iba raz s časovým limitom 5 s – status_url zostáva vždy zdrojom pravdy.

Chyby

Všetky chyby majú { "error": { "code", "message", ... } } – strojovo čitateľný kód, zrozumiteľnú správu pre človeka a field, ak je chyba v konkrétnom vstupnom poli.