دليل مصادقة واجهة برمجة التطبيقات

مصادقة واجهة برمجة تطبيقات سمارت لايف

تدعم واجهة REST API لسمارت لايف طريقتين للمصادقة: مفاتيح API (للتكاملات من خادم إلى خادم) وOAuth 2.0 (للتطبيقات الموجهة للمستخدم).

مصادقة مفتاح API

مفاتيح API هي الطريقة الأبسط للمصادقة. قم بتضمين مفتاحك في ترويسة Authorization:

• الترويسة: Authorization: Bearer YOUR_API_KEY
• يجب إجراء جميع طلبات API عبر HTTPS
• لا تعرض مفتاح API الخاص بك في كود جانب العميل أبداً

مصادقة OAuth 2.0

للتطبيقات التي تتصرف نيابة عن المستخدمين، استخدم تدفق Authorization Code لـ OAuth 2.0:

• سجل تطبيقك في بوابة المطورين > تطبيقاتي
• أعِد توجيه المستخدمين إلى عنوان URL للتفويض في سمارت لايف
• استبدل رمز التفويض برمز الوصول
• استخدم رمز الوصول في طلبات API الخاصة بك
• جدد الرموز عند انتهاء صلاحيتها (تدوم الرموز ساعة واحدة)

حدود المعدل

تفرض واجهة API حدوداً للمعدل لضمان الاستخدام العادل:

• خطة Starter: 1,000 طلب/ساعة
• خطة Professional: 10,000 طلب/ساعة
• خطة Enterprise: حدود مخصصة

رموز الأخطاء

• 401 غير مصرح — رمز غير صالح أو منتهي الصلاحية
• 403 محظور — أذونات غير كافية لهذه العملية
• 429 طلبات كثيرة جداً — تجاوز حد المعدل