Developer apps
OAuth अनुप्रयोग
भागीदार ऐप्स बनाएं, कंपनियों तक प्रत्यायोजित पहुंच का अनुरोध करें, और बाध्य OAuth टोकन के साथ MakeCrypto API पर कॉल करें।
डेवलपर पोर्टल
https://apps.makecrypto.io पर पार्टनर एप्लिकेशन बनाएं और प्रबंधित करें। एप्लिकेशन MakeCrypto कंपनी से संबंधित हैं और रीडायरेक्ट URI, अनुमत OAuth स्कोप, webhooks, आइकन, समर्थन संपर्क, गोपनीयता नीति और सहमति के दौरान दिखाए गए शब्दों को परिभाषित करते हैं।
प्रत्येक गोपनीय एप्लिकेशन में एक ग्राहक रहस्य होता है। रहस्य एक बार दिखाया जाता है जब इसे बनाया या घुमाया जाता है, फिर केवल हैश के रूप में संग्रहीत किया जाता है। सार्वजनिक अनुप्रयोगों को PKCE का उपयोग करना चाहिए और कोई रहस्य प्राप्त नहीं करना चाहिए।
PKCE के साथ प्राधिकरण कोड
MakeCrypto भागीदार अनुप्रयोगों के लिए प्रत्यायोजित कंपनी OAuth का समर्थन करता है। सटीक पंजीकृत रीडायरेक्ट यूआरआई और PKCE S256 चुनौती के साथ उपयोगकर्ता को प्राधिकरण समापन बिंदु पर भेजकर प्रवाह शुरू करें।
GET https://makecrypto.io/oauth/authorize
?response_type=code
&client_id=mco_app_...
&redirect_uri=https%3A%2F%2Fpartner.example%2Fcallback
&scope=company%3Aread%20makepay%3Apayment-links%3Aread
&resource=https%3A%2F%2Fmakecrypto.io%2Fapi%2Fpartner%2Fv1
&code_challenge=BASE64URL_SHA256_VERIFIER
&code_challenge_method=S256
उपयोगकर्ता कंपनी चुनता है, अनुरोधित अनुमतियों की समीक्षा करता है, और पहुंच को स्वीकृत या अस्वीकार करता है। यदि अनुमोदन सफल होता है, तो MakeCrypto एक अल्पकालिक प्राधिकरण कोड के साथ वापस रीडायरेक्ट करता है।
टोकन समापन बिंदु पर कोड का आदान-प्रदान करें। गोपनीय ग्राहक client_secret_basic या client_secret_post से प्रमाणित करते हैं; सार्वजनिक ग्राहक अपने client_id और PKCE सत्यापनकर्ता के साथ प्रमाणित करते हैं।
POST https://makecrypto.io/oauth/token
Content-Type: application/x-www-form-urlencoded
Authorization: Basic base64(client_id:client_secret)
grant_type=authorization_code
&code=mco_code_...
&redirect_uri=https%3A%2F%2Fpartner.example%2Fcallback
&code_verifier=ORIGINAL_PKCE_VERIFIER
एक्सेस टोकन अल्पकालिक JWT बियरर टोकन हैं। प्रत्येक उपयोग पर रीफ्रेश टोकन घूमते हैं, और रीफ्रेश-टोकन का पुन: उपयोग टोकन परिवार को रद्द कर देता है।
आधिकारिक मूल एकीकरण, जैसे कि MakePay WordPress प्लगइन, डेवलपर पोर्टल या साझा क्लाइंट रहस्य का उपयोग नहीं करते हैं। वे POST /oauth/native/installations पर प्रति-स्टोर सार्वजनिक इंस्टॉलेशन पंजीकृत करते हैं, सटीक कॉलबैक URI मिलान का उपयोग करते हैं, और DPoP-बाउंड टोकन प्राप्त करते हैं जिन्हें Authorization: DPoP और एक मिलान DPoP प्रूफ हेडर के साथ भेजा जाना चाहिए।
आधिकारिक एसडीके
जब आप HTTP क्लाइंट, भुगतान-लिंक पेलोड और webhook हस्ताक्षर सत्यापन को शुरू से बनाए बिना सर्वर-साइड एकीकरण चाहते हैं तो आधिकारिक SDK का उपयोग करें।
| SDK | इसके लिए इसका प्रयोग करें | मार्गदर्शक |
|---|---|---|
| MakePay PHP SDK | PHP, लारवेल, सिम्फनी, कस्टम checkout, और बैकएंड भुगतान-लिंक निर्माण। | PHP SDK |
| MakePay NPM SDK | Node.js, Next.js, TypeScript बैकएंड और सर्वर-साइड webhook हैंडलर। | NPM SDK |
अंतिमबिंदुओं
| उद्देश्य | समापन बिंदु |
|---|---|
| प्राधिकरण | GET /oauth/authorize |
| टोकन एक्सचेंज | POST /oauth/token |
| निरसन | POST /oauth/revoke |
| आत्मविश्लेषण | POST /oauth/introspect |
| प्राधिकरण अनुरोध को आगे बढ़ाया | POST /oauth/par |
| मूल स्थापना पंजीकरण | POST /oauth/native/installations |
| जेडब्ल्यूकेएस | GET /oauth/jwks.json |
| प्राधिकरण सर्वर मेटाडेटा | GET /.well-known/oauth-authorization-server |
| संरक्षित संसाधन मेटाडेटा | GET /.well-known/oauth-protected-resource |
कार्यक्षेत्र
| दायरा | पहुंच |
|---|---|
company:read | चयनित कंपनी की पहचान और बुनियादी सेटिंग्स पढ़ें। |
wallet:balances:read | चयनित कंपनी के लिए वॉलेट शेष पढ़ें। |
wallet:activity:read | वॉलेट और निपटान गतिविधि पढ़ें. |
makepay:payment-links:read | MakePay भुगतान लिंक और भुगतान स्थिति पढ़ें। |
makepay:payment-links:write | MakePay भुगतान लिंक बनाएं और अपडेट करें। |
makepay:customers:read | MakePay ग्राहक रिकॉर्ड पढ़ें। |
makepay:customers:write | MakePay ग्राहक रिकॉर्ड बनाएं और अपडेट करें। |
makepay:subscriptions:read | MakePay सदस्यता रिकॉर्ड पढ़ें। |
makepay:subscriptions:write | MakePay सब्सक्रिप्शन बनाएं और अपडेट करें। |
makepay:settings:read | MakePay व्यापारी सेटिंग और सक्षम संपत्ति पढ़ें। |
makepay:settings:write | MakePay मर्चेंट सेटिंग और कॉलबैक कॉन्फ़िगरेशन अपडेट करें। |
makepay:webhooks:read | MakePay webhook एंडपॉइंट और डिलीवरी लॉग पढ़ें। |
makepay:webhooks:write | MakePay webhook डिलीवरी बनाएं, अपडेट करें, परीक्षण करें और पुनः प्रयास करें। |
API मार्ग अनुमतियाँ
| मार्ग | विधि | आवश्यक दायरा |
|---|---|---|
/api/partner/v1/makepay/payment-links | GET | makepay:payment-links:read |
/api/partner/v1/makepay/payment-links | POST | makepay:payment-links:write |
/api/partner/v1/makepay/customers | GET | makepay:customers:read |
/api/partner/v1/makepay/customers | POST | makepay:customers:write |
/api/partner/v1/makepay/subscriptions | GET | makepay:subscriptions:read |
/api/partner/v1/makepay/subscriptions | POST | makepay:subscriptions:write |
/api/partner/v1/makepay/settings | GET | makepay:settings:read |
/api/partner/v1/makepay/settings | PUT | makepay:settings:write |
/api/partner/v1/makepay/webhook-requests | GET | makepay:webhooks:read |
/api/partner/v1/companies/{id}/wallet/balances | GET | wallet:balances:read |
/api/partner/v1/companies/{id}/wallet/activity | GET | wallet:activity:read |
Webhook हस्ताक्षर करना
एप्लिकेशन webhooks में टाइमस्टैम्प और v1 हस्ताक्षर मानों के साथ एक makecrypto-signature हेडर शामिल है। टाइमस्टैम्प ताजगी को सत्यापित करें, हस्ताक्षरित पेलोड को timestamp.rawBody के रूप में पुनर्निर्माण करें, और समापन बिंदु बनाए या घुमाए जाने पर एक बार दिखाए गए webhook रहस्य के साथ हस्ताक्षर की तुलना करें।
कनेक्टेड ऐप प्रबंधन
स्वीकृत OAuth अनुदान कंपनी के डैशबोर्ड में Integrations -> Connected apps के अंतर्गत दिखाई देते हैं। कंपनी एडमिन ऐप की स्थिति, अंतिम एक्सेस और दिए गए दायरे की समीक्षा कर सकते हैं, फिर जब पार्टनर कनेक्शन काम करना बंद कर दे तो एक्सेस रद्द कर सकते हैं।