Pakkaus-API

Pika-aloitus

1. Kirjaudu sisään → klikkaa nimeäsi → API → luo avain.
2. Lähetä pakkauspyyntö (tämä suoritetaan sandbox-tilassa — ilmainen jokaisella suunnitelmalla):

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

Tarkista status_url (sama autentikointiotsake) kunnes 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/..."
  }
}

Rajapintakutsut

Vastauksen kentät

Valmiin työn result-objekti:

Versiointi ja vakaus

Sopimus on versioitu polussa (/api/v1/). Versiossa v1 muutokset ovat vain lisäyksiä — uusia valinnaisia pyyntökenttiä, uusia vastauskenttiä, uusia ajoneuvokoodeja ja virhekoodeja voi ilmestyä, ja asiakkaiden tulee ohittaa kentät, joita ne eivät tunnista. Olemassa olevien kenttien merkitys tai tyyppi ei koskaan muutu, eikä mitään poisteta. Rikkova muutos tarkoittaa uutta versiopolkua, ja v1:tä ylläpidetään rinnakkain vähintään 12 kuukauden ajan, ja poistosta ilmoitetaan sähköpostitse jokaiselle työtilalle, jolla on aktiivinen avain.

Pyynnön kentät

Tavaran kentät

Ajoneuvokoodit

Luotu reaaliaikaisen moottorin määrittelyistä. Työtilasi kaluston mukautetut ajoneuvot toimivat custom_vehicle_id-tunnuksen avulla.

Kuorma-autot ja perävaunut

Kontit

Käyttöoikeustasot ja rajat

Vain onnistuneet kuormat lasketaan — epäonnistuneet validoinnit ja työt eivät vaikuta kiintiöön. Molemmat laskurit nollaantuvat 1. päivänä (UTC). Sandbox-tulokset ovat täysin toimivia ja rajoittamattomia — rajat koskevat vain kutsukertoja, ei tuloksia. Tarvitsetko yli 5 000 kuormaa kuukaudessa? Kysy meiltä volyymi- ja OEM-hinnoista.

Webhookit

Anna callback_url saadaksesi tuloksen POSTina, kun työ on valmis. Jokainen kutsu sisältää X-Hansatic-Signature:n, joka on HMAC-SHA256 allekirjoitus raakaruumiista avaimesi webhook-salaisuudella (näytetään kerran avaimen luonnin yhteydessä). Vahvista se:

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

Toimitus on yksi yritys 5s aikakatkaisulla — status_url säilyy aina totuuden lähteenä.

Virheet

Kaikki virheet ovat { "error": { "code", "message", ... } }-muotoisia — koneellisesti luettava koodi, ihmisluettava viesti ja field, jos tietty syöttökenttä on virheellinen.