Pakkimise API

Kiire algus

1. Logi sisse → klõpsa oma nimele → API → genereeri võti.
2. Saada pakkimise töö (see töötab liivakastis — tasuta iga plaaniga):

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

Küsi status_url (sama autentimispeaga) kuni status on "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/..."
  }
}

Pöördumispunktid

Vastuse väljad

result objekt lõpetatud töös:

Versioneerimine ja stabiilsus

Leping on versioneeritud teejuhises (/api/v1/). Versiooni v1 sees tehakse muudatusi ainult lisavormis — uued valikulised päringu väljad, uued vastuse väljad, uued sõidukikoodid ja veakoodid võivad ilmneda, ning kliendid peaksid ignoreerima välju, mida nad ei tunne. Olemasolevate väljade tähendus ega tüüp ei muutu, ega midagi ei eemaldata. Murdev muudatus tähendab uue versiooni teejuhet, kusjuures v1-d säilitatakse paralleelselt vähemalt 12 kuu jooksul ja hoiatatakse e-posti teel iga tööruumi omanikku, kellel on aktiivne võti.

Päringu väljad

Ese väljad

Sõidukikoodid

Genereeritud reaalajas mootori spetsifikatsioonidest. Tööruumi pargi kohandatud sõidukid töötavad läbi custom_vehicle_id.

Veoautod ja haagised

Konteinerid

Ligipääsutasemed ja piirangud

Arvesse lähevad ainult edukad pakkimised – valideerimise või töö nurjumisel kvooti ei arvestata. Mõlemad loendurid lähtestatakse 1. kuupäeval (UTC). Testkeskkonna tulemused on täielikud ja piiramatud – piirangud kehtivad sisendile, mitte väljundile. Vajad rohkem kui 5 000 pakkimist kuus? Võta meiega ühendust, et arutada mahulisi ja OEM-hinnapakkumisi.

Veebihaakujad

Saada callback_url, et saada tulemus POST-i teel, kui töö on lõpetatud. Iga veebihaak kannab endaga kaasas X-Hansatic-Signature: HMAC-SHA256 allkirja toorest kehaosast sinu võtme veebihaakude salajasega (kuvatakse üks kord võtme loomisel). Kontrolli seda:

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

Edastus tehakse ühe katsega 5s ajapiiranguga — status_url jääb alati tõe allikaks.

Vead

Kõik vead on { "error": { "code", "message", ... } } kujul — masinloetav kood, inimloetav sõnum ja field, kui konkreetne sisend on vigane.