API Shopify PDF للتطبيقات وسير الخوادم الخلفية
استدع gPdf من تطبيق Shopify أو سير خادم خلفي لإنشاء PDF للطلبات والفواتير وقوائم التعبئة والمرتجعات والملصقات من بيانات Shopify المربوطة.
/api/v1/pdf/render استخدام تطبيق Shopify أو خادم خلفي للتجارة الإلكترونية لربط بيانات الطلب والعميل والمنتج والتنفيذ والإرجاع إلى JSON أو بيانات قالب في gPdf، ثم إعادة ملفات PDF حتمية من دون ادعاء وجود تكامل أصلي في Shopify App Store.
متى تستخدم هذه API
- تبني تطبيق Shopify أو خادمًا خلفيًا خاصًا أو سير تنفيذ يستطيع استدعاء APIs خارجية.
- يتلقى تطبيقك بالفعل بيانات طلبات أو تنفيذ أو عملاء أو منتجات من Shopify.
- تحتاج إلى فواتير أو قوائم تعبئة أو مستندات إرجاع أو ملصقات مستودع أو مرفقات PDF.
- تريد عقد template_id مستقرًا لتخطيطات مستندات خاصة بالتاجر.
ما الذي لا تستبدله
- تتوقع أن يكون gPdf تطبيق Shopify رسميًا أو إدراجًا في متجر التطبيقات.
- تحتاج إلى أن يثبت gPdf داخل متجر تاجر أو يتعامل مع OAuth أو يشترك مباشرةً في webhooks.
- تحتاج إلى أسعار شحن أو شراء طوابع أو إدارة مخزون أو ميزات واجهة تاجر من gPdf.
أي مسار API يجب استدعاؤه
/api/v1/pdf/render
JSON Render هو المسار الافتراضي لسير العمل هذا.
/api/v1/template-render
استخدمه عندما يحتاج سير العمل إلى مسار API مرتبط، أو عقد قالب، أو استعلام capabilities.
طلب مختصر
POST /api/v1/template-render - خادم التطبيق الخلفي يرسل بيانات طلب Shopify مربوطة إلى قالب منشور.
{
"template_id": "packing_list",
"data": [
{
"order_number": "#1042",
"customer_name": "Example Buyer",
"ship_to": "1200 Market St, San Francisco, CA",
"items": [
{ "sku": "TSHIRT-BLK-M", "name": "Black T-shirt", "quantity": 2 },
{ "sku": "MUG-WHT", "name": "White mug", "quantity": 1 }
]
}
]
}
ما يتولاه gPdf
- عرض PDF من JSON مشتق من Shopify يربطه خادم تطبيقك الخلفي.
- Template Render لتخطيطات مستندات خاصة بالتاجر أو العلامة التجارية.
- باركود وQR codes وجداول وإجماليات وصور وملصقات وبنى قوائم تعبئة.
- إنشاء PDF عديم الحالة عبر واجهات gPdf العامة.
ما يبقى ضمن مسؤولية نظامك
- كود تطبيق Shopify وOAuth وwebhooks وواجهة التاجر وتوزيع متجر التطبيقات.
- ربط بيانات الطلب والتنفيذ والعميل والإرجاع والمنتج والضرائب.
- تهيئة التاجر واختيار القالب والتسليم والتخزين وإعادة المحاولة.
قائمة فحص الإنتاج
- أبق بيانات اعتماد Shopify وtokens الخاصة بـ gPdf في الخادم الخلفي، لا في كود المتصفح.
- اربط بيانات Shopify إلى بيانات عرض صريحة أو schema بيانات قالب.
- استخدم Template Render للتخطيطات الخاصة بالتاجر بعد الاعتماد.
- خزّن ملفات PDF المولدة أو بيانات المصدر وفق سير التاجر.
- وثّق أن التكامل هو تطبيقك الذي يستدعي gPdf، وليس تطبيق Shopify رسميًا من gPdf.
حدود الادعاءات
- لا تدّع وجود تطبيق Shopify عام ورسمي ما لم يكن موجودًا.
- لا يشغّل gPdf OAuth الخاص بـ Shopify أو تثبيت التطبيقات أو webhooks أو إعدادات التاجر.
- يملك المتصل ربط بيانات Shopify وقواعد أعمال التجارة الإلكترونية.
نموذج التكامل
أنظف نموذج لتكامل Shopify هو خادم إلى خادم. يتلقى تطبيقك بيانات Shopify أو يجلبها، ويربطها إلى gPdf DocumentRequest أو كائن بيانات قالب، ويستدعي gPdf، ثم يعيد PDF أو يخزنه وفق سير التاجر.
هذا يحافظ على دقة الادعاء العام: gPdf هو API إنشاء PDF الذي يستطيع تطبيق Shopify لديك استدعاءه. وليس تطبيق Shopify رسميًا عامًا ما لم يوجد منتج تطبيق منفصل.
Template Render يناسب تخطيطات التجار
غالبًا ما تصبح ملفات PDF في التجارة الإلكترونية خاصة بالتاجر: الهوية البصرية، وجداول البنود، وتعليمات الإرجاع، وكتل الملصقات، وملاحظات الهدايا، والنصوص المحلية. يتيح Template Render لتطبيقك حفظ هذه التخطيطات في قوالب منشورة بينما يرسل التطبيق بيانات الطلب المربوطة فقط.
أبق منطق المنصة داخل التطبيق
تبقى OAuth وwebhooks وإعدادات التاجر وحالة التنفيذ والمخزون وقواعد الإرجاع وتوزيع متجر التطبيقات داخل تطبيق Shopify لديك. يجب أن يستقبل gPdf بيانات العرض النهائية وينتج PDF.
الأسئلة الشائعة
- هل gPdf تطبيق Shopify رسمي؟
- لا. هذه الصفحة للتطبيقات والخوادم الخلفية التي تستدعي gPdf. لا تعرض gPdf كتكامل رسمي في Shopify App Store إلا إذا كان ذلك المنتج موجودًا.
- أين يجب أن يحدث استدعاء gPdf API؟
- استدع gPdf من خادمك الخلفي أو خادم التطبيق حيث تكون بيانات اعتماد Shopify وtokens الخاصة بـ gPdf محمية.
- هل يجب أن تستخدم ملفات Shopify PDF JSON Render أم Template Render؟
- استخدم JSON Render للتخطيطات المخصصة المولدة. واستخدم Template Render عندما يعتمد التاجر أو العلامة التجارية التخطيط ويجب أن يرسل المتصلون البيانات فقط.
- هل يتعامل gPdf مع webhooks الخاصة بـ Shopify؟
- لا. يتلقى تطبيقك webhooks، ويربط البيانات، ويقرر متى يعرض. يعرض gPdf فقط طلب PDF الذي يستقبله.