Жүктеу API

Жылдам бастау

1. Кіріңіз → атыңызды басыңыз → API → кілтті жасаңыз.
2. Жүктеу тапсырмасын жіберіңіз (бұл сынақ режимінде жұмыс істейді — әрбір тарифтік жоспарда тегін):

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

status_url мекенжайын тексеріп отырыңыз (авторизация тақырыбы сол қалпында) status "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/..."
  }
}

Мекенжайлар

Жауап өрістері

Аяқталған тапсырмадағы result нысаны:

Нұсқалау және тұрақтылық

Шарт жолдағы (/api/v1/) нұсқамен белгіленеді. v1 ішінде өзгерістер тек қосымша түрде болады — жаңа міндетті емес сұраным өрістері, жаңа жауап өрістері, жаңа көлік кодтары мен қате кодтары пайда болуы мүмкін, ал клиенттер танымайтын өрістерді елемеуі керек. Өмір сүріп жатқан өрістердің мағынасы мен типі ешқашан өзгермейді, ештеңе жойылмайды. Бұзушы өзгеріс жаңа нұсқа жолын білдіреді, ал v1 параллель режимде кем дегенде 12 ай бойы қолдаулы болып, белсенді кілті бар әрбір жұмыс аймағына электрондық пошта арқылы ескерту жіберіледі.

Сұраным өрістері

Зат өрістері

Көлік кодтары

Тірі қозғалтқыш спецификацияларынан жасалған. Сіздің жұмыс аймағыңыздағы арнайы көліктер custom_vehicle_id арқылы жұмыс істейді.

Жүк машиналары мен тіркемелер

Контейнерлер

Қолжетімдік деңгейлері мен лимиттер

Тек сәтті пакеттеулер ғана есептеледі — жарамсыз деректерді тексеру және орындалмаған тапсырмалар квотаға есептелмейді. Екі есептегіш те айдың 1-і күні (UTC) нөлден басталады. Sandbox нәтижелері толық және шектеусіз — лимит тек шектеу ретінде қолданылады, нәтижелерге әсер етпейді. Айына 5,000 пакеттен артық қажет пе? Көлемді және OEM бағалары туралы бізбен байланысыңыз.

Вебхуктар

Тапсырма аяқталғанда нәтижені POST арқылы алу үшін callback_url беріңіз. Әрбір хабарламада X-Hansatic-Signature болады: сіздің кілттің вебхук құпия сөзімен (кілт жасалған кезде бір рет көрсетіледі) HMAC-SHA256 қолтаңбасы. Оны тексеріңіз:

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

Хабарлама бір рет жіберіледі, уақыты 5с — status_url әрқашан шындық көзі болып қалады.

Қателер

Барлық қателер { "error": { "code", "message", ... } } пішінде — машина оқитын код, адамға түсінікті хабарлама және қате кіріс мәліметі болған кезде field.