API من بوابة العملاء

إنشاء رابط البوابة

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

POST /api/partner/v1/makepay/customers/{customerId}/portal

يقبل customerId العميل المخزن UUID أو العميل UID. نص الطلب فارغ.

curl -X POST "https://www.makecrypto.io/api/partner/v1/makepay/customers/CUSTOMER_ID/portal" \
  -H "x-makecrypto-key-id: MAKEPAY_API_KEY_ID" \
  -H "x-makecrypto-key-secret: MAKEPAY_API_SECRET" \
  -H "Accept: application/json"

المصادقة

تتم مصادقة عمليات تكامل الخادم باستخدام مفتاح MakePay API. يمكن لجلسات المستعرض استدعاء مسار لوحة المعلومات على مستوى الشركة عندما يكون لدى المستخدم الذي قام بتسجيل الدخول settings.manage في الفريق المحدد. لا تمرر طلبات مفتاح API معرف الشركة في URL لأن المفتاح ينتمي بالفعل إلى شركة واحدة.

إجابة

يقوم المسار بإرجاع كائن العميل بالإضافة إلى رابط urls.customerPortal الموقع.

{
  "ok": true,
  "companyId": "acct_123",
  "customer": {
    "id": "b834dd77-69b8-41a9-a4b6-95bc9dd14c2d",
    "uid": "cus_01hzy4k6p4w9y2x7e2z7n8a2xm",
    "email": "buyer@example.com",
    "name": "Ada Lovelace",
    "clientId": "client_1042",
    "metadata": {
      "source": "api"
    },
    "createdAt": "2026-04-20T10:00:00.000Z",
    "updatedAt": "2026-04-20T10:00:00.000Z",
    "urls": {
      "customerPortal": "https://makepay.io/billing?company=acct_123&customer=cus_01hzy4k6p4w9y2x7e2z7n8a2xm&expires=1776765600&signature=8d1f..."
    }
  },
  "expiresAt": "2026-04-21T10:00:00.000Z"
}

معلمات URL الموقعة

البوابة الإلكترونية التي تم إرجاعها URL لها هذا الشكل:

https://{makepay-or-verified-merchant-domain}/billing?company={companyId}&customer={customerUid}&expires={unixSeconds}&signature={hexHmac}

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

نطاق البوابة

تعرض البوابة فقط البيانات المطابقة للشركة والعميل الموقعين:

• ملخص الملف الشخصي Customer واسم العرض القابل للتحرير.
• سجل الدفع المطابق للبريد الإلكتروني للعميل أو معرف العميل.
• روابط دفع نشطة أو غير مدفوعة مع MakePay URLs المستضاف.
• الاشتراكات المطابقة للبريد الإلكتروني للعميل أو معرف عميل البيانات الوصفية.
• إيقاف الإجراءات مؤقتًا وإعادة تنشيطها وإلغائها لحالات الاشتراك المدعومة.

لا يمكن تغيير البريد الإلكتروني ومعرف العميل وملفات PDF وطرق الدفع ومفاتيح الترخيص وتبديل الخطة وتدفقات السيرة الذاتية للاشتراك الملغى في إصدار البوابة الإلكترونية الأول.