Ачааны 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-ээр ашиглана.

Ачааны машин, чиргүүл

Контейнерүүд

Хандалтын түвшин ба хязгаарлалт

Зөвхөн амжилттай багц тоологдоно — баталгаажуулалт болон ажлын алдаа нь хязгаарыг тооцохгүй. Хоёр тоолуур нь UTC-ээр сарын 1-нд шинэчлэгдэнэ. Тест орчинд үр дүн бүрэн, хязгаарлалтгүй байх бөгөөд хязгаар нь зөвхөн хэрэглээний түвшин, гаралтын чанарт нөлөөлөхгүй. Сар бүр 5,000-гаас илүү багц хэрэгтэй юу? Том хэмжээ болон OEM үнийн санал авахын тулд бидэнтэй холбогдоно уу.

Webhook-ууд

Ажил дууссаны дараа үр дүнг POST-оор хүлээн авахын тулд callback_url илгээнэ үү. Бүх callback-д X-Hansatic-Signature байна: таны түлхүүрийн webhook нууц үгийн (түлхүүр үүсгэх үед ганц удаа харуулсан) 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.