प्रमाणीकरण
PayerScan API API Key प्रमाणीकरण का उपयोग करता है। प्रत्येक स्टोर के पास अपनी अद्वितीय API Key होती है, जो हर अनुरोध में शामिल करनी आवश्यक है।
अनुरोध Header
सभी API अनुरोधों में x-api-key header आवश्यक है:
x-api-key: YOUR_API_KEY
अनुरोध उदाहरण
curl -X POST https://api.payerscan.com/payment/crypto \
-H "Content-Type: application/json" \
-H "x-api-key: YOUR_API_KEY" \
-d '{"merchant_id": "YOUR_MERCHANT_ID", "amount": 10, "callback_url": "https://your-server.com/webhook"}'
API Key प्राप्त करना
- मर्चेंट डैशबोर्ड में लॉगिन करें।
- Stores पृष्ठ पर जाएं।
- तालिका में अपना स्टोर खोजें — API Key और Merchant ID कॉलम सीधे प्रदर्शित होते हैं।
- कॉपी करने के लिए Copy बटन पर क्लिक करें। नई key चाहिए तो Regenerate बटन का उपयोग करें।
सुरक्षा चेतावनी
- कभी भी API Key को क्लाइंट-साइड कोड (ब्राउज़र, मोबाइल ऐप) में उजागर न करें।
- केवल अपने बैकएंड सर्वर से API कॉल करें।
- यदि लीक होने का संदेह हो तो तुरंत API Key बदलें।
यह कैसे काम करता है
क्लाइंट → आपका बैकएंड → PayerScan API
↑
x-api-key header
- आपका बैकएंड क्लाइंट से भुगतान अनुरोध प्राप्त करता है।
- आपका बैकएंड
x-api-keyheader के साथ PayerScan API को कॉल करता है। - PayerScan API Key सत्यापित करता है, जांचता है कि स्टोर और मर्चेंट अकाउंट सक्रिय हैं।
- वैध होने पर, अनुरोध संसाधित किया जाता है और प्रतिक्रिया लौटाई जाती है।
त्रुटि प्रतिक्रिया प्रारूप
प्रमाणीकरण विफल होने पर, API JSON प्रतिक्रिया लौटाता है:
{
"status": "error",
"message": "Invalid API key. Please check your API key and try again.",
"error_code": "INVALID_API_KEY"
}
प्रमाणीकरण त्रुटि कोड
| HTTP स्थिति | त्रुटि कोड | विवरण |
|---|---|---|
401 | MISSING_API_KEY | x-api-key header गायब या खाली है। |
401 | INVALID_API_KEY | API Key गलत है या किसी सक्रिय स्टोर से संबंधित नहीं है। |
403 | ACCOUNT_INACTIVE | मर्चेंट अकाउंट अक्षम कर दिया गया है। सहायता से संपर्क करें। |
403 | STORE_INACTIVE | स्टोर अक्षम कर दिया गया है। सहायता से संपर्क करें। |
500 | AUTHENTICATION_FAILED | प्रमाणीकरण के दौरान आंतरिक सर्वर त्रुटि। बाद में पुनः प्रयास करें। |
tip
यदि आपको ACCOUNT_INACTIVE या STORE_INACTIVE प्राप्त होता है, तो कृपया अपना अकाउंट पुनः सक्रिय करने के लिए payerscan.com पर सहायता से संपर्क करें।