Iepakojuma API

Ātrā sākšana

1. Pieteikties → noklikšķiniet uz savas lietotājvārda → API → ģenerējiet atslēgu.
2. Iesniedziet iepakojuma uzdevumu (šis darbojas testrežīmā — bez maksas katrā plānā):

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ārbaudiet status_url (ar to pašu autentifikācijas galveni) līdz status ir "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/..."
  }
}

Galvenes

Atbildes lauki

result objekts pabeigtam uzdevumam:

Versiju pārvaldība un stabilitāte

Līgums ir versiju pārvaldīts ceļa nosaukumā (/api/v1/). Ietvaros v1 izmaiņas ir tikai papildinājošas — jauni neobligāti pieprasījuma lauki, jauni atbildes lauki, jauni transportlīdzekļu kodi un kļūdu kodi var parādīties, un klientiem jāignorē lauki, kurus tie neatpazīst. Esošie lauki nekad nemaina nozīmi vai tipu, un nekas netiek noņemts. Lūzuma izmaiņa nozīmē jaunu versijas ceļu, kamēr v1 tiek uzturēts paralēli vismaz 12 mēnešus, un noņemšanas paziņojums tiek nosūtīts pa e-pastu katrai darba telpai ar aktīvu atslēgu.

Pieprasījuma lauki

Vienību lauki

Transportlīdzekļu kodi

Ģenerēti no tiešsaistes dzinēja specifikācijām. Jūsu darba telpas flotes pielāgotie transportlīdzekļi darbojas, izmantojot custom_vehicle_id.

Kravas automašīnas un piekabes

Konteineri

Piekļuves līmeņi un ierobežojumi

Tiek skaitīti tikai veiksmīgi izpildītie pakošanas plāni — nepareizi validēti vai neizdevušies uzdevumi nekādā veidā neietekmē kvotas. Abi skaitītāji atiestatās 1. datumā (UTC). Sandbox rezultāti ir pilnīgi un neierobežoti — ierobežojumi attiecas tikai uz piekļuvi, ne uz izejas datiem. Vajadzīgas vairāk nekā 5000 pakošanas plāni mēnesī? Sazinieties ar mums par lielapjoma un OEM cenu nosacījumiem.

Webhook

Norādiet callback_url, lai saņemtu rezultātu ar POST, kad uzdevums būs pabeigts. Katrs izsaukums satur X-Hansatic-Signature: HMAC-SHA256 no neapstrādāta ķermeņa ar jūsu atslēgas webhook slepeno kodu (parādīts vienreiz atslēgas izveides brīdī). Pārbaudiet to:

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

Piegāde notiek vienā mēģinājumā ar 5 s laika limitu — status_url vienmēr paliek patiesības avots.

Kļūdas

Visas kļūdas ir { "error": { "code", "message", ... } } formātā — mašīnlasāmais kods, cilvēkam saprotams paziņojums un field, ja vainojams konkrēts ievades lauks.