المصادقة
يحتاج كل طلب إلى مفتاح الواجهة البرمجية. تقبل نقطتا النهاية المفتاح بأي من الطرق التالية، فتحتفظ بالأسلوب الذي يستخدمه تكاملك الحالي.
طرق إرسال المفتاح
| الطريقة | مثال | الشائع لدى |
|---|---|---|
| المصادقة الأساسية (Basic) | اسم المستخدم api، وكلمة المرور = مفتاحك | عملاء PDFShift |
ترويسة X-API-Key | X-API-Key: sk_live_... | أي عميل |
معامل الاستعلام access_key | /take?access_key=sk_live_...&url=... | عملاء ScreenshotOne |
ترويسة X-Access-Key | X-Access-Key: sk_live_... | أي عميل |
| رمز Bearer | Authorization: Bearer sk_live_... | أي عميل |
إذا كان المفتاح مفقودًا أو خاطئًا، تكون الاستجابة 401 مع {"success": false, "error": "Invalid or missing API key"}.
أبقِ المفتاح على خادمك
- استدعِ الواجهة البرمجية من الخادم الخلفي، لا من المتصفح ولا من تطبيق الجوال. فكل من يرى المفتاح يستطيع استهلاك عملياتك.
- فضّل الترويسة على معامل الاستعلام
access_keyمتى أمكن، لأن سلاسل الاستعلام كثيرًا ما تنتهي في سجلات الوكلاء وسجل المتصفح وأدوات تتبع الأخطاء لديك. أما خادم صحيفة فلا يسجّل سلاسل الاستعلام أبدًا. - احفظ المفتاح في متغير بيئة أو في مدير أسرار، لا في المستودع.
- إذا احتمل أن يكون المفتاح قد انكشف، راسلنا على support@sahifa.dev وسنستبدله.
التجربة دون مفتاح
يستخدم العرض التجريبي في الصفحة الرئيسية محرك الإنشاء نفسه، مع حد صفحة واحدة وعلامة مائية وعدد محدود من المحاولات في الساعة.