PDF ACCESS CLOUD / التوثيق
التوثيق
كل ما تحتاجه لنشر تطبيق HTTP محلي.
البداية السريعة
قبل البدء
تحتاج إلى Node.js 22.13 أو أحدث وتطبيق HTTP يعمل محليًا. أنشئ حسابًا ثم نفقًا في لوحة التحكم. احفظ رمز الموصل عند عرضه؛ لن تتمكن من استرجاعه لاحقًا.
إنشاء نفقاحتفظ بسرية رمز الموصل
عيّن PAC_CONNECTOR_TOKEN في الطرفية ثم شغّل الموصل الذي نزلته. يختلف الرمز عن مفتاح API ويخص نفقًا واحدًا. جدده في لوحة التحكم إذا فقدته أو انكشف.
تنزيل الموصل ↓# Set the token returned when you create a tunnel
read -rs PAC_CONNECTOR_TOKEN
export PAC_CONNECTOR_TOKEN
node connect.mjs --port 3000# Set the token returned when you create a tunnel
$secureToken = Read-Host 'Connector token' -AsSecureString
$env:PAC_CONNECTOR_TOKEN = [Net.NetworkCredential]::new('', $secureToken).Password
node connect.mjs --port 3000مرجع الواجهة البرمجية
أنشئ مفتاح API في لوحة التحكم وأرسله في ترويسة Authorization. يمكن للمفاتيح إدارة أنفاق حسابك ومفاتيحه؛ احمها مثل كلمة المرور. تُستخدم رموز الموصل في الموصل فقط.
curl https://pdf-access-cloud.com/api/tunnels \
-H "Authorization: Bearer $PAC_API_KEY"| الطريقة | المسار | الوظيفة |
|---|---|---|
GET | /api/tunnels | عرض أنفاقك |
POST | /api/tunnels | إنشاء نفق وعرض الرمز مرة واحدة |
DELETE | /api/tunnels/:id | حذف نفق وقطع اتصاله |
POST | /api/tunnels/:id/token | تجديد رمز الموصل |
GET | /api/keys | عرض بيانات المفاتيح |
POST | /api/keys | إنشاء مفتاح وعرضه مرة واحدة |
DELETE | /api/keys/:id | إلغاء مفتاح API |
POST /api/tunnels
Content-Type: application/json
{"name": "my-preview"}
201 Created
{
"tunnel": {
"id": "…",
"name": "my-preview",
"slug": "…",
"url": "https://….tunnel.pdf-access-cloud.com",
"status": "offline",
"requests": 0
},
"connectorToken": "…"
}الأخطاء
تُرجع الأخطاء بصيغة JSON. الرمز 401 لبيانات اعتماد مفقودة أو غير صالحة، و403 لرفض الوصول، و404 لمورد غير متاح، و409 لتعارض الحساب، و429 لبلوغ الحد. يُرجع النفق غير المتصل الرمز 503.
OpenAPI 3.1 JSONالنطاق والحدود
تمرر النسخة التجريبية طلبات HTTP واستجاباتها. لا تمرر اتصالات WebSocket للتطبيقات أو TCP/UDP العام أو الاستجابات المتدفقة. حد جسم الطلب 2 MiB والاستجابة 4 MiB والمهلة 30 ثانية. يجب إبقاء الموصل قيد التشغيل.
حتى 5 أنفاق و10 مفاتيح API لكل حساب. الحد الأقصى لجسم الطلب هو 2 MiB وللاستجابة 4 MiB والمهلة 30 ثانية. لا يدعم هذا الإصدار تطبيقات WebSocket أو الاستجابات المتدفقة.