API Keys

एपीआई कुंजी बनाएं

POST /api/v1/api-keys

प्रमाणीकृत उपयोगकर्ता के लिए एक नई एपीआई कुंजी बनाता है।

अनुरोध निकाय

{
  "name": "My integration"
}

फ़ील्ड	आवश्यक	विवरण
name	हाँ	कुंजी के लिए प्रदर्शन नाम (1–100 वर्ण)

प्रतिक्रिया

{
  "data": {
    "id": "key_uuid",
    "name": "My integration",
    "prefix": "rm_abc123",
    "key": "rm_abc123def456...",
    "created_at": "2025-09-19T15:00:00.000Z"
  }
}

सावधानी

key फ़ील्ड केवल निर्माण के समय ही एक बार लौटाया जाता है। इसे सुरक्षित रूप से संग्रहीत करें - इसे फिर से प्राप्त नहीं किया जा सकता है। बाद के अनुरोधों में केवल prefix (पहले 8 वर्ण) दिखाए जाते हैं।

---

एपीआई कुंजियों को सूचीबद्ध करें

GET /api/v1/api-keys

प्रमाणीकृत उपयोगकर्ता के लिए सभी एपीआई कुंजियों को लौटाता है। निर्माण के बाद पूर्ण कुंजी मान कभी नहीं लौटाया जाता है।

प्रतिक्रिया

{
  "data": [
    {
      "id": "key_uuid",
      "name": "My integration",
      "prefix": "rm_abc123",
      "created_at": "2025-09-19T15:00:00.000Z",
      "last_used_at": "2025-09-20T10:30:00.000Z",
      "is_revoked": false
    }
  ]
}

---

एपीआई कुंजी रद्द करें

DELETE /api/v1/api-keys/:id

एक एपीआई कुंजी को स्थायी रूप से रद्द करता है। इस कुंजी का उपयोग करने वाले अनुरोध INVALID_API_KEY के साथ तुरंत विफल हो जाएंगे।

प्रतिक्रिया

{
  "data": { "success": true }
}

त्रुटि कोड

कोड	HTTP स्थिति	अर्थ
API_KEY_NOT_FOUND	404	कुंजी मौजूद नहीं है या किसी अन्य उपयोगकर्ता से संबंधित है
ALREADY_REVOKED	400	कुंजी पहले ही रद्द कर दी गई थी