Logistics and labels

واجهة API لـ PDF لوجستي في أنظمة الإنتاج

أنشئ PDF لوجستي من بيانات backend منظمة بدون متصفح، مع فصل واضح بين PDF rendering الذي ينفذه gPdf ومنطق العمل في نظامك.

API الرئيسي JSON Render
ENDPOINT /api/v1/pdf/render
الأنظمة backend تشغيلي / نظام مالي / workflow امتثال / خدمة مستندات
المهمة المطلوبة

إنشاء PDF لوجستي كملف PDF قابل لإعادة الإنتاج من بيانات منظمة. يتولى gPdf إخراج PDF، بينما يبقى معنى البيانات وحالة workflow في نظامك.

متى تستخدم هذه API

  • لدى backend بيانات PDF لوجستي بالفعل ويحتاج إلى استجابة PDF ثابتة.
  • تريد تجنب Chromium أو HTML-to-PDF في مستندات التشغيل.
  • تحتاج إلى output قابل للإعادة للطباعة، التدقيق أو المعالجة الدفعية.

ما الذي لا تستبدله

  • gPdf لا يشتري الشحن، لا يقدّم ضرائب، لا ينشئ أوامر خارجية ولا يعمل كنظام ضريبي.
  • لا يستبدل data validation أو business rules أو تكاملات marketplace.

أي endpoint يجب استدعاؤه

الرئيسي

/api/v1/pdf/render

JSON Render هو المسار الافتراضي لهذا workflow.

ثانوي 1

/api/v1/template-render

استخدمه عندما يحتاج workflow إلى API مرتبط، عقد template، أو capabilities lookup.

Request مختصر

/api/v1/pdf/render - PDF لوجستي

{
  "template_id": "packing_list",
  "data": [
    {
      "order_number": "SO-8421",
      "warehouse": "LAX-01",
      "ship_to": "Example Retailer, 88 Harbor Rd, Long Beach, CA",
      "items": [
        { "sku": "CASE-001", "description": "Widget case", "quantity": 4 },
        { "sku": "CASE-002", "description": "Replacement kit", "quantity": 1 }
      ]
    }
  ]
}

ما يتولاه gPdf

  • PDF rendering لـ PDF لوجستي من request منظم.
  • النصوص، الجداول، الخطوط، الباركود، الصفحات، metadata وخيارات الإخراج حسب request.
  • Output حتمي للـ retry وإعادة الطباعة والتدقيق.

ما يملكه نظامك

  • البيانات الصحيحة لـ PDF لوجستي، قواعد العمل وحالة العملية.
  • Authentication، التخزين، workflows الخارجية والتحقق لدى النظام المستقبل.

Checklist الإنتاج

  1. اختبر ببيانات حقيقية وبالأنظمة التي ستستهلك PDF.
  2. احتفظ بـ request IDs وأدلة التحقق للدعم، التدقيق وإعادة الطباعة.
  3. حوّل layout المعتمد إلى template عندما تعيد عدة أنظمة استخدامه.

حدود الادعاء

  • gPdf يرندر PDF الملصق؛ لا يشتري الشحن، لا ينشئ shipment ولا يصادق carrier.
  • Payload، الطابعات، مخزون الملصقات، routing واختبارات المسح تبقى في نظامك.

شكل API

واجهة API لـ PDF لوجستي هو production workflow مبني على APIs العامة في gPdf. يصف request البيانات، layout، settings وأجزاء PDF المطلوب render لها. ينشئ gPdf ملف PDF؛ ويبقى معنى business event في نظامك.

اختيار endpoint

الـ endpoint الافتراضي لهذا workflow هو /api/v1/pdf/render. استخدم Template Render بعد اعتماد layout وإعادة استخدامه بين الأنظمة. استخدم E-Invoice Render فقط عند الحاجة إلى Factur-X / ZUGFeRD PDF/A-3b مع EN 16931 CII XML مدمج.

التحقق قبل الإنتاج

تحقق من PDF لوجستي ببيانات حقيقية وبالأنظمة downstream. احتفظ بـ request IDs، output وأدلة validation للدعم، التدقيق وإعادة الطباعة.

FAQ

هل هذا endpoint منفصل؟
واجهة API لـ PDF لوجستي يربط workflow بمسار API عام في gPdf. توضح الصفحة أي path يجب استدعاؤه وما الذي يملكه request.
هل يمكن استخدام templates؟
نعم. استخدم JSON Render عندما يتغير layout، ثم Template Render بعد اعتماد layout وإرسال callers لبيانات العمل فقط.
ما الذي يجب التحقق منه قبل الإنتاج؟
تحقق ببيانات حقيقية وبالطابعات، الماسحات، validators، أنظمة المحاسبة أو marketplace حسب workflow.