يستدعي عميلي واجهة برمجة التطبيقات لتتبع Cargoes Flow. ما الذي يجب أن أغيّره لتشغيلها على Dockflow؟
قيمتان:
- غيّر المضيف. يمكن للعميل الذي يحتفظ بمساره الخاص استخدام https://api.dockflow.com/compat/cargoes-flow/flow/api/public_tracking/v1
- ضع مفتاح API الخاص بـ Dockflow في X-DPW-ApiKey. أنشئ المفتاح في وحدة تحكم API بنطاق Downstream. يتم قبول X-DPW-Org-Token وتجاهله.
لا توجد مواصفات عامة متاحة للاختبار عليها، لذا تجري أول خطوة نحو هذه الواجهة بالتعاون مع Dockflow، على سبيل التحقق. تواصل مع الدعم للتخطيط لذلك.
مثال تطبيقي، بمفتاح وهمي:
POST /compat/cargoes-flow/createShipments
X-DPW-ApiKey: prod_acme_FAKE-TOKEN
{"uploadType":"FORM_BY_MBL_NUMBER","formData":[{"mblNumber":"MB-4471","oceanLine":"MAEU"}]}
الاستجابة:
{"result":"SUCCESS","errorDetail":[],
"shipments":[{"shipmentNumber":"DF74123","mblNumber":"MB-4471","created":true}]}
الصفوف إما كلها أو لا شيء: صف واحد خاطئ في formData يعني عدم إنشاء أي شيء، وتكون الاستجابة FAILED مع errorDetail على HTTP 200.
اقرأه باستخدام GET /shipments وshipmentNumber=DF74123. أضف includeUniqueContainers=true للحصول على صف واحد لكل حاوية. تبقى الانبعاثات والأجزاء البرية فارغة. يحمل كل تسليم webhook ترويسة X-Dockflow-Signature.
تعيين الحقول الكامل والتحقق من التوقيع: