نظرة عامة على Management API

Management API هي الواجهة البرمجية لكل ما يمكنك فعله في لوحة تحكم Scanova: إنشاء رموز QR وتحديثها، إدارة المجلدات والوسوم، قراءة العملاء المحتملين (leads) وإرسالات النماذج، سحب التحليلات، وإدارة المستخدمين المشاركين وأدوارهم. إنها مضيف منفصل عن بقية سطح API الخاص بـ Scanova، وله مخطط مصادقة خاص به.

تغطي هذه الصفحة البنية المعمارية التي تنطبق على كل نقطة نهاية في Management API. للاطلاع على القائمة الكاملة لنقاط النهاية، راجع الصفحات المرتبطة أسفل هذه الصفحة.

للبدء

أنشئ مفتاح Management API

أثناء تسجيل دخولك إلى لوحة تحكم Scanova، أنشئ مفتاحًا عبر واجهة إدارة المفاتيح في لوحة التحكم — راجع إنشاء مفاتيح API وإدارتها. اختر environment — sandbox أو live أو zapier أو mcp — عند إنشائه؛ هذا الاختيار دائم لهذا المفتاح ويحدد حصة الخطة التي تُفحص مع كل طلب يقوم به المفتاح (انظر أدناه).

خزّن القيمة الخام للمفتاح

قيمة المفتاح التي تعيدها استدعاء الإنشاء هي المرة الوحيدة التي سترى فيها المفتاح كاملًا — خزّنه بأمان. لا توجد نقطة نهاية “لإظهاره” لاحقًا.

استدعِ نقاط نهاية البيانات

أرسل المفتاح كقيمة خام لترويسة Authorization إلى api.scanova.io، مثلًا GET /qr/ لسرد رموز QR الخاصة بك.

حصة الخطة

كل طلب إلى نقطة نهاية بيانات يفحص حصة خطة مرتبطة بـ environment الخاصة بالمفتاح:

`environment`	الحصة المفحوصة	يتطلب أيضًا
`live` أو `sandbox`	`MANAGEMENT_API`	—
`zapier`	`INTEGRATION_ZAPIER`	يجب أن تكون ترويسة `User-Agent` الخاصة بالطلب حرفيًا `zapier`
`mcp`	`INTEGRATION_MCP`	يجب أن تكون ترويسة `User-Agent` الخاصة بالطلب حرفيًا `mcp`

إذا أعاد طلب إلى مضيف البيانات الرمز 401 مع الرسالة “Your plan does not have management API quota” (أو ما يعادلها الخاص بـ Zapier/MCP)، فهذا يعني أن خطتك لا تمنح تلك الحصة. حاليًا، لا تتضمن خطة Pro القياسية الوصول إلى Management API — فقط خطط Free Trial وEnterprise وInternal تتضمنه. تواصل مع support@scanova.io إذا كنت تعتقد أن حسابك ينبغي أن يملك هذه الميزة.

sandbox مجرد مفهوم تصنيف وحصة فقط — إنه ليس بيئة اختبار معزولة. المفتاح المُنشأ بـ environment: sandbox يقرأ ويكتب نفس رموز QR والمجلدات والعملاء المحتملين الحقيقيين التي يستخدمها مفتاح live. لا تعتمد عليه لبيانات اختبار قابلة للتخلص منها.

مفتاح zapier/mcp يُصادق إضافيًا فقط عندما تتطابق ترويسة User-Agent الخاصة بالعميل المستدعي مع بيئته — مفتاح zapier يرفض الطلبات ما لم تكن User-Agent: zapier، وكذلك الأمر بالنسبة لـ mcp. يُطبَّق هذا بشكل مستقل عن فحص الحصة أعلاه.

محتويات هذا القسم

سرد رموز QR

GET /qr/ — نقطة نهاية البيانات الأساسية التي تبدأ بها معظم عمليات التكامل.

إنشاء رمز QR

POST /qr/ — نقطة نهاية البيانات الأساسية التي تبدأ بها معظم عمليات التكامل.

راجع الشريط الجانبي للاطلاع على القائمة الكاملة، بما في ذلك استرجاع رمز QR واحد أو تحديثه أو حذفه، وتنزيل صور رموز QR، وتصفح سلة المهملات.

البدء