التوثيق الشامل
مرحباً بك في دليل PDF Enterprise الشامل. هذا الدليل سيساعدك على فهم واستخدام جميع ميزات المنصة بشكل فعال.
البدء السريع
PDF Enterprise هي منصة متطورة لتحويل HTML إلى PDF مصممة خصيصاً للشركات والمؤسسات. إليك كيفية البدء:
1. الحصول على المفتاح
أولاً، تحتاج إلى الحصول على مفتاح API من لوحة التحكم:
API_KEY=your-secure-api-key-here
2. إعداد البيئة
قم بإنشاء ملف .env في مشروعك:
NODE_ENV=production
PORT=3001
API_KEY=your-secure-api-key-here
LARAVEL_URL=https://your-domain.com
3. اختبار الاتصال
تأكد من أن الخدمة تعمل بشكل صحيح:
curl http://localhost:3001/health
مرجع API
جميع طلبات API تستخدم JSON وتتطلب header Content-Type: application/json
Base URL
التطوير
http://localhost:3001
الإنتاج
https://pdf.trivon.net
المصادقة
جميع الطلبات تتطلب مفتاح API صالح. أضف المفتاح في header:
Authorization: Bearer your-api-key
نقاط النهاية
فحص حالة الخدمة
| الطريقة | المسار | الوصف |
|---|---|---|
| GET | /health | فحص حالة الخدمة |
| GET | /stats | إحصائيات الخدمة |
| POST | /generate-pdf | توليد PDF |
| POST | /analyze-html | تحليل HTML ذكي |
| POST | /validate-html | التحقق من HTML |
| POST | /preview-html | معاينة HTML |
توليد PDF
استخدم هذا endpoint لتحويل HTML إلى PDF:
POST /generate-pdf
Content-Type: application/json
{
"html": "<!DOCTYPE html><html><body><h1>مرحباً</h1></body></html>",
"options": {
"format": "A4",
"printBackground": true,
"margin": {
"top": "10mm",
"right": "10mm",
"bottom": "10mm",
"left": "10mm"
}
}
}
تحليل HTML
احصل على تحليل شامل لـ HTML مع توصيات:
POST /analyze-html
Content-Type: application/json
{
"html": "<!DOCTYPE html><html><body>محتوى HTML</body></html>"
}
أمثلة عملية
مثال JavaScript
const response = await fetch('http://localhost:3001/generate-pdf', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer your-api-key'
},
body: JSON.stringify({
html: `
<!DOCTYPE html>
<html lang="ar" dir="rtl">
<head>
<meta charset="UTF-8">
<title>تقرير الشركة</title>
</head>
<body>
<h1>تقرير الأداء الشهري</h1>
<p>هذا مثال لتوليد PDF باللغة العربية</p>
</body>
</html>
`,
options: {
format: 'A4',
printBackground: true
}
})
});
const pdfBlob = await response.blob();
مثال cURL
curl -X POST http://localhost:3001/generate-pdf \
-H "Content-Type: application/json" \
-H "Authorization: Bearer your-api-key" \
-d '{
"html": "<html><body><h1>مرحباً</h1></body></html>",
"options": {
"format": "A4",
"printBackground": true
}
}' \
--output document.pdf
معالجة الأخطاء
المنصة ترجع أخطاء واضحة مع رموز HTTP مناسبة:
أخطاء شائعة
400 Bad Request
طلب غير صحيح - تحقق من البيانات المرسلة
401 Unauthorized
مفتاح API غير صالح أو منتهي الصلاحية
429 Too Many Requests
تم تجاوز حد الطلبات المسموح
500 Internal Server Error
خطأ في الخادم - تواصل مع الدعم الفني
أفضل الممارسات
- استخدم HTML صحيح: تأكد من استخدام HTML صحيح مع DOCTYPE
- الخطوط العربية: استخدم خطوط عربية مثل Cairo أو Amiri
- اتجاه RTL: أضف dir="rtl" للدعم الكامل للعربية
- تحسين الصور: استخدم صور محسنة للطباعة
- اختبار التحليل: استخدم /analyze-html قبل التحويل
- إدارة الأخطاء: تعامل مع الأخطاء بشكل مناسب
- التخزين المؤقت: استخدم التخزين المؤقت للطلبات المتكررة
استكشاف الأخطاء
مشاكل شائعة
خطأ في تثبيت Playwright
قم بإعادة تثبيت Playwright: npm run install-playwright
مشاكل في الخطوط العربية
تأكد من استخدام خطوط عربية وإضافة dir="rtl"
مشاكل في التنسيق
تأكد من إضافة printBackground: true واستخدام وحدات CSS مناسبة
الحصول على المساعدة
إذا واجهت مشاكل، يمكنك:
- مراجعة هذا الدليل
- اختبار الـ API باستخدام Postman Collection
- التواصل مع الدعم الفني
- مراجعة السجلات في لوحة التحكم