API reference

प्रमाणीकरण

API कुंजी हेडर, गुप्त प्रबंधन, अनुमतियाँ और रोटेशन।

क्रेडेंशियल मॉडल

MakePay API कुंजियाँ MakeCrypto डेवलपर क्षेत्र से बनाई गई हैं और एक टीम तक सीमित हैं। प्रत्येक कुंजी में एक सार्वजनिक कुंजी आईडी और एक रहस्य होता है। रहस्य को हैश के रूप में संग्रहीत किया जाता है और निर्माण के बाद केवल एक बार दिखाया जाता है।

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 करें.

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 का अर्थ है कि साइन-इन किया गया उपयोगकर्ता टीम तक नहीं पहुंच सकता है या उसके पास आवश्यक अनुमति नहीं है।
जब टीम के लिए चयनित partnerId मौजूद नहीं होता है, तो कुंजी-प्रबंधन मार्गों द्वारा 404 API key not found लौटाया जाता है।