Pakke-API

Kom i gang

1. Logg inn → klikk på navnet ditt → API → generer en nøkkel.
2. Send en pakkejobb (denne kjører i sandbox — gratis på alle abonnementer):

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

Poll status_url (samme autentiseringsheader) til status er "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/..."
  }
}

Endepunkter

Svarsfelt

result-objektet for en fullført jobb:

Versjonering og stabilitet

Kontrakten er versjonert i stien (/api/v1/). Innen v1 er endringer kun additive — nye valgfrie forespørselsfelt, nye svarsfelt, nye kjøretøykoder og feilkoder kan dukke opp, og klienter bør ignorere felt de ikke kjenner igjen. Eksisterende felt endrer aldri betydning eller type, og ingenting fjernes. En brytende endring medfører en ny versjonssti, med v1 vedlikeholdt parallelt i minst 12 måneder og varsel om utfasing sendt på e-post til alle arbeidsområder med en aktiv nøkkel.

Forespørselsfelt

Enhetsfelt

Kjøretøykoder

Generert fra de aktive motorspesifikasjonene. Egendefinerte kjøretøy fra flåten i arbeidsområdet ditt fungerer via custom_vehicle_id.

Lastebiler og tilhengere

Containere

Tilgangsnivåer og grenser

Bare vellykkede pakkinger telles — mislykkede valideringer og mislykkede jobber belaster aldri en kvote. Begge tellerne nullstilles den 1. (UTC). Sandbox-resultater er komplette og ubegrensede — grensene gjelder tilgangen, ikke resultatet. Trenger du mer enn 5 000 pakkinger i måneden? Ta kontakt for volum- og OEM-priser.

Webhooks

Angi callback_url for å motta resultatet via POST når jobben er ferdig. Hver callback inneholder X-Hansatic-Signature: en HMAC-SHA256 av rådataene med webhook-hemmeligheten din (vises én gang ved nøkkelopprettelse). Verifiser den:

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

Levering er ett forsøk med 5s timeout — status_url forblir alltid den endelige sannhetskilden.

Feil

Alle feil er { "error": { "code", "message", ... } } — maskinlesbar kode, menneskelig lesbar melding, og field når et bestemt inndatafelt er feil.