واجهة REST

واجهة برمجية يمكن التنبؤ بها، مصممة لإدماج سريع

مفاتيح لكل بيئة، آلية Idempotency، أخطاء صريحة، ويب هوكس موقّعة: كل ما تنتظرونه من واجهة أداء حديثة.

إنشاء حساب سندبوكس استكشفوا الواجهة البرمجية

إنشاء رابط دفع

X-CHARI-PAY-API-KEY: chari_sk_test_… POST /v1/payment-links{  "amount": 149.90,  "description": "Commande n° 1234",  "externalId": "order-1234"} // 201 Created{  "reference": "pl_3ND8xk",  "status": "ACTIVE",  "currency": "MAD",  "payUrl": "https://…"}

الاصطلاحات

اصطلاحات لا تفاجئكم

المفتاح هو البيئة

مفتاح السندبوكس يعمل على بيانات الاختبار، ومفتاح الإنتاج على البيانات الحقيقية. مجموعتا البيانات منفصلتان — فقط احتفظوا بمفاتيح idempotency متمايزة بين البيئتين.

Idempotency

أعيدوا النداء بنفس externalId: تستعيدون الكائن الموجود، ولا يُنشأ نسخة مكررة أبدًا.

أخطاء صريحة

غلاف موحّد، رمز آلي ثابت وcorrelationId في كل استجابة — نجاحًا كانت أم خطأ.

حدود استعمال شفافة

النقاط المكشوفة للعموم (المصادقة، صفحة الدفع، الويب هوكس الواردة) تعلن X-RateLimit-Limit وRemaining وReset، وتردّ 429 مع Retry-After عند التجاوز.

مفاتيح بصلاحيات دقيقة

مفاتيح لكل مؤسسة ولكل بيئة، وصلاحيات (scopes) لكل وحدة — المفتاح الكامل يُعرض مرة واحدة فقط، عند إنشائه.

ويب هوكس موقّعة

كل حدث موقّع بـ HMAC مع طابع زمني، ويُعاد إرساله تلقائيًا إذا كان خادمكم غير متاح.

فضاء المطوّرين

مفاتيحكم، والويب هوكس الخاصة بكم، وسجلاتكم

أنشئوا مفتاح سندبوكس في دقيقة، وصرّحوا بعناوين الاستقبال، وأعيدوا قراءة كل تسليم بالرمز الذي ردّ به خادمكم.

فضاء المطوّرين في بوابة ChariPay: مفاتيح الواجهة ونقاط استقبال الويب هوكس وسجل التسليمات. — المفتاح الكامل يُعرض مرة واحدة فقط، عند إنشائه: احفظوه في خزنة أسرار.

ويب هوكس يمكنكم الوثوق بها

تحققوا من التوقيع قبل قراءة المحتوى، أزيلوا التكرار عبر معرّف الحدث، وأجيبوا بـ 2xx بعد المعالجة: المنصة تتكفل بإعادة الإرسال. روابط الإشعارات تتطلب HTTPS.

توقيع HMAC وطابع زمني في كل حدث
إعادة إرسال تلقائية عند عدم التوفر
HTTPS إلزامي على كل روابط الإشعارات

webhook

// En-têtes reçusX-CHARI-SIGNATURE: a3f19c… (HMAC-SHA256)X-CHARI-TIMESTAMP: 1756166400000Chari-Event-Id: 9f2c31a4-…Chari-Event-Type: payment.succeeded // Corps — signé tel quel, octet par octet{ … }

ابدؤوا دون طلب الإذن منا

بيئة اختبار كاملة — مفاتيح API، وويب هوكس، وبيانات وهمية — بتسجيل ذاتي بالكامل: أنشئوا حسابكم عبر الإنترنت، وفعّلوه بالبريد الإلكتروني، وسجّلوا الدخول إلى البوابة وأنشئوا مفتاح API بأنفسكم. لا بريد إلى الدعم، ولا التزام.

المرجع الكامل للواجهة البرمجية — 62 نقطة نهاية مع أمثلة curl وJavaScript وPython وPHP — منشور على هذا الموقع ومتاح للجميع.

من أول نداء إلى الإنتاج

أنشئوا مفتاح السندبوكس
تسجيل عبر الإنترنت، وتفعيل بالبريد الإلكتروني، ومفتاح يُنشأ من البوابة — يُعرض مرة واحدة فقط.
أدمجوا واختبروا
روابط وجلسات واشتراكات وويب هوكس — كل شيء متاح في السندبوكس.
انتقلوا إلى الإنتاج
بعد قبول ملف KYB وتفعيل الحساب، يتولى مفتاح الإنتاج المهمة.

مستعدون لأول نداء؟

أنشئوا حساب سندبوكس أو حدّثونا عن إدماجكم.

اتصلوا بنا