पैकिंग एपीआई

त्वरित शुरुआत

1. साइन इन करें → अपने नाम पर क्लिक करें → एपीआई → एक कुंजी जनरेट करें।
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) को रीसेट होते हैं। सैंडबॉक्स के परिणाम पूर्ण और बिना किसी सीमा के होते हैं — सीमाएँ केवल गेट होती हैं, आउटपुट नहीं। 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", ... } } होती हैं — मशीन-readable कोड, मानव-readable संदेश, और field जब कोई विशिष्ट इनपुट दोषपूर्ण हो।