نظرة عامة على المصادقة
تدعم API الخاصة بـ OrcaRail طريقتين للمصادقة لحالات استخدام مختلفة. سجّل الدخول إلى لوحة التحكم؛ يستخدم الوصول إلى لوحة التحكم رموز Bearer (تحصل عليها عند تسجيل الدخول). إذا كانت هذه أول مرة تسجّل فيها الدخول، فيجب أن تنشئ مؤسسة قبل متابعة استخدام لوحة التحكم أو إنشاء مفاتيح API.
طرق المصادقة
1. رمز Bearer (JWT)
استخدم رموز Bearer للطلبات التي يصادق عليها المستخدم، مثل إنشاء مستخدم مسجّل الدخول لـ Payment Intent أو إدارته لموارد مؤسسته.
حالة الاستخدام: التطبيقات الموجهة للمستخدم، والوصول إلى لوحة التحكم، والعمليات الخاصة بالمستخدم
صيغة الترويسة:
Authorization: Bearer YOUR_JWT_TOKEN
2. مفتاح API (Basic Auth)
استخدم مفاتيح API للطلبات من خادم إلى خادم، مثل الخدمات الخلفية التي تستدعي API. تُنشأ مفاتيح API داخل مؤسسة.
حالة الاستخدام: التواصل من خادم إلى خادم، والعمليات المؤتمتة، والـ webhooks
صيغة الترويسة:
Authorization: Basic base64(key:secret)
اختيار طريقة المصادقة
| السيناريو | الطريقة الموصى بها |
|---|---|
| مستخدم ينشئ دفعة من تطبيقك | رمز Bearer (JWT) |
| خدمة خلفية تنشئ مدفوعات | مفتاح API (Basic Auth) |
| الوصول إلى لوحة التحكم | رمز Bearer (JWT) |
| معالجة الـ webhooks | مفتاح API (Basic Auth) |
| استدعاءات API من تطبيق جوال | رمز Bearer (JWT) |
الخطوات التالية
- مفاتيح API — تعرّف على كيفية إنشاء مفاتيح API واستخدامها
- رموز Bearer — تعرّف على كيفية المصادقة برموز JWT