دليل المنتج وAPI
البدء السريع
خمس دقائق إلى أول مستند
تنقلك هذه الصفحة من الصفر إلى PDF محفوظ على القرص. تستخدم قالب الفاتورة الذي تبدأ به كل مساحة عمل، فلا تحتاج إلى تصميم شيء أولًا.
1. مفتاحك
أنشئ مفتاحًا ضمن الحساب ← مفاتيح API. تظهر القيمة السرية مرة واحدة؛ أبقها خارج الشيفرة المصدرية. يحملها كل استدعاء في ترويسة X-PDFgine-Key.
cURL
# يوضع المفتاح في البيئة لا في الشيفرة
export PDFGINE_KEY="pdfgine_live_..."
# هل يعمل؟ يسرد هذا الاستدعاء قوالبك
curl https://api.pdfgine.com/api/v1/templates \
-H "X-PDFgine-Key: $PDFGINE_KEY"
2. أنشئ مستندًا
استدعاء واحد برمز القالب وبياناتك. تكون الاستجابة 202 مع documentId وعنوان URL للتنزيل.
cURL
curl -X POST https://api.pdfgine.com/api/v1/render \
-H "X-PDFgine-Key: $PDFGINE_KEY" \
-H "Content-Type: application/json" \
-d '{
"templateCode": "invoice",
"format": "pdf",
"locale": "ar",
"data": {
"document": { "title": "ملخص الفاتورة" },
"referenceNo": "DOC-2026-0042",
"issueDate": "2026-09-06",
"currency": "USD",
"customer": "Northwind Trading Ltd.",
"lineItems": [
{ "name": "تشخيص العطل", "quantity": 2, "unitPrice": 850.00 }
]
}
}'
أثناء تجربة قالب، أرسل "purpose": "editor-test": لن يستهلك الناتج من حصتك وسيستخدم المسودة غير المنشورة.
3. نزّله
عنوان URL للتنزيل في الاستجابة نسبي إلى عنوان API ويُجلب بالمفتاح نفسه. اطلب docx بدل pdf لتحصل على البيانات نفسها كملف Word.
cURL
curl https://api.pdfgine.com/api/v1/documents/doc_a96063f5dcd5400286ce9b3be9b0595b/download/pdf \
-H "X-PDFgine-Key: $PDFGINE_KEY" \
-o invoice.pdf
الأخطاء الأولى الشائعة
- تعني 402 نفاد حصة الصفحات الشهرية؛ وتخبرك ترويسة X-PDFgine-Quota-Remaining قبل بلوغ ذلك.
- تعني 422 أن بياناتك لا تلبي متطلبات القالب. يسرد المحتوى جميع الحقول المفقودة تحت errors كي لا تضطر للتخمين.
- يستجيب الإنشاء بالحالة 202 وليس 200. العميل الذي يعد أي حالة غير 200 فشلًا سيبلّغ عن النجاح كخطأ.
الخطوة التالية
ستعود كثيرًا إلى صفحة تنسيقات البيانات؛ فهي توضح بالضبط كيفية إرسال التاريخ والمبلغ والعملة.
تنسيقات البيانات →