API reference

ग्राहक पोर्टल से API

सहेजे गए ग्राहकों के लिए MakePay ग्राहक पोर्टल से हस्ताक्षरित URLs उत्पन्न करता है।

एक पोर्टल लिंक जनरेट करें

संग्रहीत MakePay ग्राहक प्रोफ़ाइल से एक MakePay ग्राहक पोर्टल लिंक बनाएं। लिंक तभी जेनरेट करें जब ग्राहक या व्यापारी बिलिंग पर क्लिक करें, फिर लौटाए गए URL को रीडायरेक्ट करें या खोलें।

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

customerId संग्रहीत ग्राहक UUID या ग्राहक UID को स्वीकार करता है। अनुरोध का मुख्य भाग खाली है.

curl

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 में एक कंपनी आईडी पास नहीं करते क्योंकि कुंजी पहले से ही एक कंपनी की है।

Header	Value	Notes
`x-makecrypto-key-id`	MakePay API key ID	MakePay payment APIs के लिए `mk_makepay_` से शुरू होता है.
`x-makecrypto-key-secret`	One-time API secret	केवल key बनाते समय दिखता है. इसे अपने server-side secret manager में store करें.

प्रतिक्रिया

रूट ग्राहक ऑब्जेक्ट और एक हस्ताक्षरित urls.customerPortal लिंक लौटाता है।

json

{
  "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}

पैरामीटर	नोट्स
`company`	MakeCrypto कंपनी खाता आईडी जो ग्राहक का स्वामी है।
`customer`	MakePay ग्राहक UID ने उस कंपनी का दायरा बढ़ाया।
`expires`	सेकंड में यूनिक्स टाइमस्टैम्प। लिंक 24 घंटे के लिए वैध हैं।
`signature`	संस्करण, कंपनी, ग्राहक और समाप्ति मूल्यों पर HMAC हस्ताक्षर।

MakePay किसी भी पोर्टल डेटा को लोड करने से पहले हस्ताक्षर और समाप्ति की पुष्टि करता है। पोर्टल URLs को स्थायी रूप से संग्रहीत न करें। प्रत्येक बटन क्लिक पर एक ताज़ा लिंक पुन: उत्पन्न करें।

पोर्टल का दायरा

पोर्टल केवल वही डेटा दिखाता है जो हस्ताक्षरित कंपनी और ग्राहक से मेल खाता है:

Customer प्रोफ़ाइल सारांश और संपादन योग्य प्रदर्शन नाम।
भुगतान इतिहास का मिलान ग्राहक के ईमेल या क्लाइंट आईडी से किया जाता है।
होस्ट किए गए MakePay URLs के साथ सक्रिय या अवैतनिक भुगतान लिंक।
ग्राहक ईमेल या मेटाडेटा क्लाइंट आईडी से मेल खाने वाली सदस्यताएँ।
समर्थित सदस्यता स्थितियों के लिए कार्रवाइयों को रोकें, पुनः सक्रिय करें और रद्द करें।

पहले पोर्टल संस्करण में ईमेल, क्लाइंट आईडी, पीडीएफ, भुगतान विधियां, लाइसेंस कुंजी, योजना स्विचिंग और रद्द-सदस्यता फिर से शुरू प्रवाह परिवर्तनीय नहीं हैं।