API अनुरोध प्रमाणित करें

API कुंजी हेडर भेजें

सार्वजनिक प्रोग्रामेटिक API https://api.threetone.in से उपलब्ध है। API कुंजी को अनुरोध के x-api-key हेडर में भेजें:

curl --request GET \
  --url 'https://api.threetone.in/v1/convai/agents' \
  --header "x-api-key: $THREETONE_API_KEY"

कुंजी को हेडर के मान के रूप में उपयोग करें। इसे URL, क्वेरी स्ट्रिंग या अनुरोध बॉडी में न डालें। प्रोग्रामेटिक अनुरोध को x-api-key भेजना चाहिए; इसे Authorization हेडर के साथ भेजना अस्पष्ट माना जाता है और अस्वीकार होता है।

कुंजी सर्वर पर रखें

कुंजी को सर्वर-साइड सीक्रेट मैनेजर या पर्यावरण चर से लोड करें। इसे फ़्रंटएंड JavaScript, मोबाइल ऐप बंडल, लॉग या त्रुटि संदेशों में न रखें। हर तैनात एकीकरण के लिए अलग, सीमित अधिकार वाली कुंजी रखें ताकि एक लीक हुआ क्रेडेंशियल असंबंधित कार्यों को उजागर न करे।

अनुरोध ID दर्ज करें

Threetone प्रतिक्रिया में X-Request-Id हेडर देता है। समस्या निवारण के लिए इसका मान अनुरोध का समय, विधि, पथ और स्थिति के साथ रखें। आप अपना मान्य X-Request-Id भी भेज सकते हैं; API उसे प्रतिक्रिया में वापस देता है।