Pak-API

Vinnige begin

1. Meld aan → klik op jou naam → API → genereer 'n sleutel.
2. Stuur 'n pakopdrag in (hierdie een loop in sandbox — gratis op elke pakket):

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

Vra die status_url op (dieselfde autentiseringskop) totdat status "done" is:

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

Eindpunte

Antwoordvelde

Die result-objek by 'n voltooide opdrag:

Weergawes & stabiliteit

Die kontrak word in die pad (/api/v1/) geïwersioneer. Binne v1 is veranderinge slegs additief — nuwe opsionele versoekvelde, nuwe antwoordvelde, nuwe voertuigkodes en foutkodes mag verskyn, en kliënte moet velde ignoreer wat hulle nie herken nie. Bestaande velde verander nooit van betekenis of tipe nie, en niks word verwyder nie. 'n Onderbrekende verandering beteken 'n nuwe weergawepad, met v1 wat minstens 12 maande parallel onderhou word en 'n afkondigingskennisgewing per e-pos aan elke werkruimte met 'n aktiewe sleutel gestuur word.

Versoekvelde

Itemvelde

Voertuigkodes

Gegenereer vanuit die lewende enjinspesifikasies. Pasgemaakte voertuie uit jou werksruimtevloot werk via custom_vehicle_id.

Vragmotors & sleepwaens

Houers

Toegangsvlakke & perke

Slegs suksesvolle pakkies tel — mislukte validasies en mislukte take word nooit teen 'n kwota aangerek nie. Albei tellers herstel op die 1ste (UTC). Sandbox-resultate is volledig en onbeperk — die limiete is die poort, nie die uitset nie. Behoefte aan meer as 5 000 pakkies per maand? Praat met ons oor volume- en OEM-pryse.

Webhooks

Gee callback_url deur om die resultaat via POST te ontvang wanneer die opdrag voltooi is. Elke terugroep bevat X-Hansatic-Signature: 'n HMAC-SHA256 van die rou lyf met jou sleutel se webhook-geheim (eenmalig by sleutel skepping vertoon). Verifieer dit:

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

Aflewering is een poging met 'n 5s-tydperk — die status_url bly altyd die bron van waarheid.

Foute

Alle foute is { "error": { "code", "message", ... } } — masjienleesbare kode, mensleesbare boodskap, en field wanneer 'n spesifieke invoer foutief is.