प्रमाणीकरण
सभी एपीआई अनुरोधों को एपीआई कुंजी का उपयोग करके प्रमाणित किया जाना चाहिए।
मूल यूआरएल
Section titled “मूल यूआरएल”https://api.recordmeeting.com/v1एपीआई कुंजी प्रमाणीकरण
Section titled “एपीआई कुंजी प्रमाणीकरण”अपनी एपीआई कुंजी को Authorization हेडर में शामिल करें:
Authorization: Bearer <your_api_key>एक एपीआई कुंजी बनाने के लिए, उपयोगकर्ता मार्गदर्शिका → एपीआई कुंजियाँ देखें।
उदाहरण अनुरोध
Section titled “उदाहरण अनुरोध”curl -X GET "https://api.recordmeeting.com/v1/recordings" -H "Authorization: Bearer rm_your_api_key_here"त्रुटि प्रतिक्रियाएँ
Section titled “त्रुटि प्रतिक्रियाएँ”सभी त्रुटियाँ इस प्रारूप का पालन करती हैं:
{ "error": { "code": "ERROR_CODE", "message": "मानव पठनीय विवरण" }}प्रमाणीकरण त्रुटि कोड
Section titled “प्रमाणीकरण त्रुटि कोड”| कोड | HTTP स्थिति | अर्थ |
|---|---|---|
UNAUTHORIZED | 401 | Authorization हेडर गुम या गलत बना हुआ है |
INVALID_API_KEY | 401 | कुंजी मौजूद नहीं है या रद्द कर दी गई है |
API_KEY_EXPIRED | 401 | कुंजी की समय सीमा समाप्त हो गई है |
USER_NOT_FOUND | 401 | कुंजी से जुड़ा उपयोगकर्ता अब मौजूद नहीं है |
FORBIDDEN | 403 | प्रमाणित, लेकिन इस संसाधन के लिए अनुमति का अभाव |
सामान्य त्रुटि कोड
Section titled “सामान्य त्रुटि कोड”| कोड | HTTP स्थिति | अर्थ |
|---|---|---|
RECORDING_NOT_FOUND | 404 | रिकॉर्डिंग आईडी मौजूद नहीं है या सुलभ नहीं है |
RECORDING_LOCKED | 403 | सुविधा के लिए सदस्यता अपग्रेड की आवश्यकता है |
VALIDATION_ERROR | 400 | अमान्य या गुम अनुरोध पैरामीटर |
INTERNAL_ERROR | 500 | सर्वर-साइड त्रुटि |