نظرة عامة على API

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

Sandbox (المضيف العام الحالي):

https://api.morisbox.com/api/v1

تقع جميع نقاط النهاية تحت /api/v1 ما لم يُذكر خلاف ذلك.

البيئةعنوان URL الأساسي
Sandboxhttps://api.morisbox.com/api/v1
Docker محليhttp://127.0.0.1:11300/api/v1
خدمة Sandboxعنوان URL
Partner Hubhttps://partner.morisbox.com
وثائق الشركاءhttps://docs.morisbox.com/partners
وثائق المطورينhttps://developers.morisbox.com/developers
لوحة المطورhttps://developers.morisbox.com/login
Application Clienthttps://morisbox.com

الاصطلاحات

الموضوعالقاعدة
التنسيقطلب JSON / استجابة JSON
المصادقةAuthorization: Bearer <api_key>
أرقام الهاتفE.164 (+228XXXXXXXX)
التواريخسلاسل ISO-8601
الأخطاء{ "error": { "code", "message" } }
الإنشاء الناجحعادةً 201

سطحا API

السطحالمفتاحالجمهورالوثائق
Partner APIsk_…المؤسسات الشريكةهذا الموقع (الرسائل والروبوتات…)
Developer APIsk_dev_…المطورون المستقلونdocs.morisbox.com/developers

مجموعات الموارد (الشركاء)

المجموعةالبادئةالوثائق
الرسائل/messagesالرسائل
إثبات التسليم/messages/{id}/auditالأمان والامتثال
عمليات البث/broadcastsعمليات البث
القوالب/templatesالقوالب
الحسابات/accountsالحسابات والربط
المحادثات/conversationsالمحادثات
الروبوتات/botsالروبوتات
التحقق/validate/*التحقق من الحقول
الإعدادات/settings/*المفاتيح والمستخدمون والحقول والامتثال

مجموعات الموارد (المطورون)

المجموعةالبادئةالوثائق
المصادقة/auth/developer/*المطورون
الملف الشخصي / الإعدادات/dev/me, /dev/settingsالمطورون
المفاتيح/dev/api-keysالمطورون
قوالب MorisBox/dev/templatesالمطورون
الرسائل/dev/messagesالمطورون

مثال للشريك: سرد الرسائل

GET /api/v1/messages?phone=%2B228XXXXXXXX&limit=20
Authorization: Bearer sk_…

مثال للمطور: الإرسال باستخدام قالب

POST /api/v1/dev/messages
Authorization: Bearer sk_dev_…
Content-Type: application/json

{
  "phone": "+228XXXXXXXX",
  "template_code": "notification",
  "lang": "fr",
  "vars": { "text": "Bonjour" }
}

حدود الطلبات

قد تُطبق حدود لكل مفتاح. عند تقييد المعدل: 429 + إشارة إلى وقت إعادة المحاولة. فضّل عمليات البث للأحجام الكبيرة (الشركاء).

الإصدارات

الإصدار العام الحالي: v1. ستستخدم التغييرات غير المتوافقة بادئة جديدة (/api/v2) أو فترة إهمال موثقة.