Pakke-API

Hurtig start

1. Log ind → klik på dit navn → API → generér en nøgle.
2. Indsend en pakkeopgave (denne kø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 autentificeringsheader) indtil 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

Svarfelter

result-objektet for en afsluttet opgave:

Versionering og stabilitet

Kontrakten er versioneret i stien (/api/v1/). Inden for v1 er ændringer kun additive — nye valgfrie forespørgselsfelter, nye svarsfelter, nye køretøjskoder og fejlkoder kan forekomme, og klienter bør ignorere felter, de ikke genkender. Eksisterende felter ændrer aldrig betydning eller type, og intet fjernes. En brydende ændring betyder en ny versionssti, hvor v1 vedligeholdes parallelt i mindst 12 måneder med afviklingsmeddelelse pr. e-mail til alle workspaces med en aktiv nøgle.

Forespørgselsfelter

Varerfelter

Køretøjskoder

Genereret ud fra de aktuelle motorspecifikationer. Brugerdefinerede køretøjer fra din workspace-flåde fungerer via custom_vehicle_id.

Lastbiler og trailere

Containere

Adgangsniveauer og begrænsninger

Kun vellykkede pakninger tæller — mislykkede valideringer og fejlede jobs trækker ikke fra kvoten. Begge tællere nulstilles den 1. (UTC). Sandbox-resultater er komplette og ubegrænsede — grænserne er adgangsporten, ikke outputtet. Har du brug for mere end 5.000 pakninger om måneden? Kontakt os for at høre om volumen- og OEM-priser.

Webhooks

Angiv callback_url for at modtage resultatet via POST, når opgaven er færdig. Hver callback indeholder X-Hansatic-Signature: en HMAC-SHA256 af den rå body med din nøgles webhook-hemmelighed (vises én gang ved nøglegenerering). Verificér 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 sker i ét forsøg med 5 s timeout — status_url er altid den endelige sandhedskilde.

Fejl

Alle fejl er { "error": { "code", "message", ... } } — maskinlæsbar kode, menneskeligt læsbar besked og field, når et bestemt input er fejlbehæftet.