مرجع API

المصادقة

API رؤوس المفاتيح والإدارة السرية والأذونات والتناوب.

نموذج الاعتماد

يتم إنشاء مفاتيح MakePay API من منطقة مطوري MakeCrypto ويتم تخصيصها لفريق واحد. يحتوي كل مفتاح على معرف مفتاح عام وسر. يتم تخزين السر كتجزئة ويظهر مرة واحدة فقط بعد إنشائه.

Header	القيمة	ملاحظات
`x-makecrypto-key-id`	معرف مفتاح MakePay API	يبدأ بـ `mk_makepay_` لواجهات MakePay payment APIs.
`x-makecrypto-key-secret`	سر API لمرة واحدة	يظهر فقط عند إنشاء المفتاح. خزنه في مدير الأسرار من جهة الخادم.

API إنشاء المفتاح

يمكن للمستخدمين الذين قاموا بتسجيل الدخول بإذن settings.manage إنشاء مفاتيح من خلال البوابة الإلكترونية أو من خلال مسار تكامل الفريق.

استخدم مسار اكتشاف الشركة التي تم تسجيل الدخول إليها عندما تحتاج أداة البوابة الإلكترونية إلى إظهار الفرق المتاحة للمستخدم الحالي:

GET /api/partner/v1/companies

يتم استخدام الشركة المرتجعة id لمسارات لوحة المعلومات/إدارة المفاتيح فقط. تعمل مسارات الدفع من خادم إلى خادم MakePay على حل الشركة من مفتاح API، لذا فهي لا تتطلب معرف شركة في URL.

POST /api/partner/v1/companies/{companyId}/integrations
Content-Type: application/json

{
  "name": "Production backend",
  "appSlug": "makepay",
  "allowedOrigins": ["https://merchant.example"]
}

تتضمن الاستجابة integration.key_id وintegration.partner_id وintegration.keySecret. احفظ keySecret على الفور.

طلب المصادقة

أرسل معرف المفتاح والسر كرؤوس إلى مسارات رابط الدفع MakePay.

x-makecrypto-key-id: mk_makepay_...
x-makecrypto-key-secret: mksec_...

يقبل API أيضًا جلسات متصفح MakeCrypto التي تم تسجيل الدخول إليها لاستدعاءات واجهة مستخدم البوابة الإلكترونية. يجب أن تستخدم عمليات التكامل من خادم إلى خادم الرؤوس الرئيسية بحيث تكون الطلبات مستقلة عن جلسة المستخدم.

الأذونات

تقبل مسارات القراءة أي عضو في الفريق مسجل الدخول أو مفتاح MakePay API صالح. تتطلب المسارات المتغيرة settings.manage لجلسات المتصفح. يتم التعامل مع مفاتيح API على أنها بيانات اعتماد خادم موثوقة للفريق المالك، لذا اجعلها مقتصرة على الأنظمة الخلفية التي تتحكم فيها.

التدوير والإلغاء

قم بإنشاء مفتاح جديد، ونشره على الواجهة الخلفية لديك، ثم قم بتعطيل المفتاح القديم أو حذفه في منطقة مطور MakeCrypto. لا يمكن الكشف عن الأسرار الموجودة مرة أخرى بعد الخلق.

أخطاء المصادقة

401 Unauthorized يعني أن الطلب لا يحتوي على جلسة صالحة ولا يوجد زوج مفاتيح API صالح.
401 Invalid MakePay API credentials يعني أن معرف المفتاح أو السر أو نطاق المنتج أو الحالة الممكّنة غير متطابقة.
403 Forbidden يعني أن المستخدم الذي قام بتسجيل الدخول لا يمكنه الوصول إلى الفريق أو أنه يفتقر إلى الإذن المطلوب.
يتم إرجاع 404 API key not found بواسطة مسارات إدارة المفاتيح عندما لا يكون partnerId المحدد موجودًا للفريق.