تغطي هذه الصفحة البنية المعمارية التي تنطبق على كل نقطة نهاية في Management API. للاطلاع على القائمة الكاملة لنقاط النهاية، راجع الصفحات المرتبطة أسفل هذه الصفحة.
مضيفان، ومخططا مصادقة
هذا هو المصدر الأكثر شيوعًا للالتباس عند التكامل مع Management API، لذا اقرأ هذا القسم قبل كتابة أي كود.
بعبارة أخرى: تُصادق بصفتك نفسك (تسجيل دخولك إلى لوحة التحكم) لإنشاء مفتاح Management API، وتُصادق بصفتك المفتاح لاستخدام Management API فعليًا.
للبدء
1
أنشئ مفتاح Management API
أثناء تسجيل دخولك إلى لوحة تحكم Scanova، أنشئ مفتاحًا عبر
POST /console/token/ (أو واجهة إدارة المفاتيح في لوحة التحكم، راجع إنشاء مفاتيح API وإدارتها). اختر environment — sandbox أو live أو zapier أو mcp — عند إنشائه؛ هذا الاختيار دائم لهذا المفتاح ويحدد حصة الخطة التي تُفحص مع كل طلب يقوم به المفتاح (انظر أدناه).2
خزّن القيمة الخام للمفتاح
قيمة المفتاح التي تعيدها استدعاء الإنشاء هي المرة الوحيدة التي سترى فيها المفتاح كاملًا — خزّنه بأمان. لا توجد نقطة نهاية “لإظهاره” لاحقًا.
3
استدعِ نقاط نهاية البيانات
أرسل المفتاح كقيمة خام لترويسة
Authorization إلى management.scanova.io، مثلًا GET /qr/ لسرد رموز QR الخاصة بك.حصة الخطة
كل طلب إلى نقطة نهاية بيانات يفحص حصة خطة مرتبطة بـenvironment الخاصة بالمفتاح:
إذا أعاد طلب إلى مضيف البيانات الرمز
401 مع الرسالة “Your plan does not have management API quota” (أو ما يعادلها الخاص بـ Zapier/MCP)، فهذا يعني أن خطتك لا تمنح تلك الحصة. حاليًا، لا تتضمن خطة Pro القياسية الوصول إلى Management API — فقط خطط Free Trial وEnterprise وInternal تتضمنه. تواصل مع support@scanova.io إذا كنت تعتقد أن حسابك ينبغي أن يملك هذه الميزة.zapier/mcp يُصادق إضافيًا فقط عندما تتطابق ترويسة User-Agent الخاصة بالعميل المستدعي مع بيئته — مفتاح zapier يرفض الطلبات ما لم تكن User-Agent: zapier، وكذلك الأمر بالنسبة لـ mcp. يُطبَّق هذا بشكل مستقل عن فحص الحصة أعلاه.
محتويات هذا القسم
إنشاء رمز API
POST /console/token/ — يولّد مفتاحًا جديدًا لبيئة مختارة.إزالة رمز API
DELETE /console/token/{key}/ — يُلغي مفتاحًا فورًا.إحصاءات الاستخدام
GET /console/usage/ — أعداد الطلبات ضمن نافذة زمنية متحركة.سرد رموز QR
GET /qr/ — نقطة نهاية البيانات الأساسية التي تبدأ بها معظم عمليات التكامل.إنشاء رمز QR
POST /qr/ — نقطة نهاية البيانات الأساسية التي تبدأ بها معظم عمليات التكامل.ذات صلة
- مقدمة مرجع API — القسم الأصلي الذي تنتمي إليه هذه النظرة العامة.
- إنشاء رمز API — أنشئ المفتاح الذي يُصادق عبره سطح هذه الـ API بأكمله.
- سرد رموز QR — نقطة نهاية البيانات الأساسية التي تبدأ بها معظم عمليات التكامل.
- إنشاء رمز QR — نقطة نهاية البيانات الأساسية التي تبدأ بها معظم عمليات التكامل.
- نظرة عامة على MCP — تكامل مبني بالكامل على نفس هذه الـ API، باستخدام بيئة
mcpمخصصة.