المصادقة في الواجهة البرمجية - Scanova API Documentation

تتطلب نقاط وصول أحداث الخادم (POST /server-events وPOST /server-events/batch) مفتاح API. أما أحداث المتصفح (POST /ct) فهي عامة ولا تحتاج إلى مصادقة — إذ يجري التحقق منها بالنطاق بدلًا من ذلك.

ترويسة مفتاح API

أرسل مفتاحك مع كل طلب حدث خادم:

POST /server-events HTTP/1.1
Host: track.scanova.io
Content-Type: application/json
X-API-Key: YOUR_SITE_API_KEY

نطاق صلاحية المفتاح

مفاتيح API مخصصة لموقع واحد. فالمفتاح المُنشأ للموقع “أ” لا يصلح لإرسال أحداث الموقع “ب”. ويجب أن تطابق site_id في جسم الطلب الموقع الذي أصدر المفتاح. وعند عدم التطابق يعود الرد 403 Forbidden.

إنشاء مفتاح

تُنشأ المفاتيح من لوحة التحكم:

انتقل إلى التحليلات ← تتبع التحويلات ← إعداد تتبع التحويلات
اختر إعداد التتبع في موقع التتبع لديك
افتح تبويب تتبع عبر API
اختر Add New Key وسمّه

يمكن أن يحتفظ الموقع بـ مفتاحين نشطين في الوقت نفسه، فاسحب المفتاح القديم عند إضافة مفتاح جديد. الإرشادات الكاملة: إنشاء مفتاح API

قواعد الأمان

لا تضع مفتاح API أبدًا في كود الواجهة الأمامية أو المتصفح — فسيكون ظاهرًا للجميع
احفظ المفاتيح في متغيرات بيئة أو في مدير أسرار (مثل AWS Secrets Manager أو HashiCorp Vault)
أنشئ مفاتيح منفصلة لبيئتَي الإنتاج والاختبار
أبطل أي مفتاح فور انكشافه بالخطأ

ردود الأخطاء

الحالة	المعنى
`401 Unauthorized`	الترويسة `X-API-Key` مفقودة
`403 Forbidden`	المفتاح غير صالح أو مُبطل، أو أن `site_id` لا تخص موقع المفتاح