For the complete documentation index, see llms.txt. This page is also available as Markdown.

REST API के साथ authenticate करें

bearer header, request body, या query parameter के माध्यम से API key से REST API requests को authenticate कैसे करें।

अधिकांश Roboflow API एंडपॉइंट्स के लिए API कुंजी या OAuth एक्सेस टोकन की आवश्यकता होती है। आप अपना अनुरोध इसके माध्यम से प्रमाणित कर सकते हैं api_key बॉडी और क्वेरी में पैरामीटर, एक प्रमाणीकरण हेडर के माध्यम से, या एक क्वेरी पैरामीटर के साथ।

उन अनुप्रयोगों के लिए जो Roboflow उपयोगकर्ताओं की ओर से प्रमाणित होते हैं, देखें Roboflow के साथ साइन इन करें (आरंभ करना). OAuth एक्सेस टोकन नीचे दी गई सभी प्रमाणीकरण विधियों के साथ काम करते हैं।

प्रमाणीकरण हेडर

हम अनुशंसा करते हैं कि आप अपनी API कुंजी को बेयरर प्रमाणीकरण हेडर के रूप में भेजकर REST API के साथ प्रमाणित करें।

यहां हेडर संरचना का एक उदाहरण है:

Authorization: Bearer abcdefghijklmnopqrstuvwxyz

बॉडी पैरामीटर

आप अपनी API कुंजी को POST एंडपॉइंट्स के JSON अनुरोध बॉडी के भीतर एक पैरामीटर के रूप में भेज सकते हैं।

यहां अनुरोध की बॉडी में API कुंजी का उपयोग करने का एक उदाहरण है:

{
    "api_key":"abcdefghijklmnopqrstuvwxyz"
}

क्वेरी पैरामीटर

आप अपनी API कुंजी को अपने अनुरोध के URL में एक क्वेरी पैरामीटर के माध्यम से भी भेज सकते हैं।

सुरक्षा कारणों से हम उत्पादन अनुप्रयोगों के लिए इस प्रमाणीकरण विधि की अनुशंसा नहीं करते हैं। इसके बजाय हम प्रमाणीकरण हेडर भेजने की अनुशंसा करते हैं।

यहां क्वेरी पैरामीटर में भेजी गई API कुंजी का एक उदाहरण है:

अंतिम अपडेट

क्या यह उपयोगी था?