البدء مع واجهة API لريتشوير

نظرة عامة على واجهة API لريتشوير

تتيح لك واجهة REST API من ريتشوير الوصول إلى تكاملاتك وتدفقات بياناتك وتقاريرك وإدارتها برمجيًا. يساعدك هذا الدليل على البدء بالمصادقة وإجراء أول طلب API.

المصادقة

تعتمد ريتشوير على مفاتيح API للمصادقة. أنشئ مفتاح API من الإعدادات > مفاتيح API (Settings > API Keys) في لوحة التحكم، وأضِف المفتاح إلى جميع الطلبات عبر ترويسة Authorization بالصيغة التالية: Authorization: Bearer YOUR_API_KEY

عنوان URL الأساسي

يجب إرسال جميع طلبات API إلى: https://api.reachware.com/v1/. تُعيد الواجهة الاستجابات بصيغة JSON، وتقبل أجسام الطلبات بصيغة JSON في طلبات POST وPUT.

حدود معدل الطلبات

يبلغ الحد الأقصى لمعدل الطلبات 100 طلب في الدقيقة للخطط القياسية، و1000 طلب في الدقيقة لخطط المؤسسات. وتُضمَّن معلومات حدود المعدل في ترويسات الاستجابة.

أول طلب API

اختبر إعداداتك بإرسال طلب GET إلى /v1/me لاسترداد معلومات حسابك. وعند نجاح الطلب، ستُعاد تفاصيل حسابك مع رمز الحالة 200.