واجهة برمجة التطبيقات (API)
تتيح لك واجهة برمجة تطبيقات OpenReplay إدارة بيانات المستخدمين وتصدير الأحداث المُلتقطة لإجراء تحليل خارجي.
عنوان URL الأساسي (v2 - الحالي)
Section titled عنوان URL الأساسي (v2 - الحالي)استخدم عنوان URL الأساسي لواجهة برمجة التطبيقات العامة v2 لجميع عمليات التكامل الجديدة. تُصادق جميع نقاط النهاية عبر مفتاح API الخاص بالمؤسسة. كل مسار مسبوق بـ /public.
- Cloud Serverless:
https://api.openreplay.com/v2 - Cloud Dedicated / الاستضافة الذاتية:
https://YOUR_INSTANCE_DOMAIN/api/v2
في جميع أجزاء الوثائق أدناه، يشير {BASE_URL} إلى عنوان URL الأساسي المنطبق على عملية النشر الخاصة بك.
المصادقة
Section titled المصادقةتتم مصادقة جميع نقاط نهاية واجهة برمجة التطبيقات العامة v2 باستخدام مفتاح API الخاص بالمؤسسة (الموجود في ‘Preferences’ > ‘Account’ > ‘Organization API Key’) المُرسَل كرمز Bearer:
Authorization: Bearer {YOUR_ORGANIZATION_API_KEY}تُرجَع الاستجابات الناجحة بتنسيق JSON ومُغلَّفة داخل { "data": ... }. أما الأخطاء فتُرجَع على هيئة { "error": "<message>" } مع رمز حالة HTTP المناسب (400، 401، 404، 409، 500، …).
عنوان URL الأساسي (v1 - مُهمَل)
Section titled عنوان URL الأساسي (v1 - مُهمَل)تظل نقاط النهاية v1 المذكورة أدناه متاحة للحفاظ على التوافق مع الإصدارات السابقة، لكنها مُهمَلة. يُرجى الانتقال إلى نقاط النهاية v2.
- لخطة Cloud Serverless:
https://api.openreplay.com/api/v1 - لمثيلات Cloud Dedicated أو المثيلات مفتوحة المصدر ذاتية الاستضافة:
https://YOUR_INSTANCE_DOMAIN/api/