प्रमाणीकरण

Partner API तक पहुँचने के लिए API सीक्रेट कुंजियों का उपयोग करके प्रमाणीकरण आवश्यक है। Partner Console के माध्यम से अपनी कुंजियाँ बनाएँ और प्रबंधित करें।

API कुंजियाँ पार्टनर संसाधनों तक पहुँचने के लिए आपके क्रेडेंशियल के रूप में काम करती हैं। हर कुंजी की पहुँच विशिष्ट संगठन डेटा तक सीमित होती है और आवश्यकता पड़ने पर उसे तुरंत निष्क्रिय किया जा सकता है।

अपनी API कुंजियों को सावधानी से संभालें—वे आपके खाते तक पूर्ण पहुँच देती हैं! इन कुंजियों को कभी भी सार्वजनिक रिपॉज़िटरी, क्लाइंट-साइड एप्लिकेशन या किसी भी ऐसी जगह उजागर न करें जहाँ उनसे समझौता हो सकता है।

अपनी API कुंजी को यूज़रनेम के रूप में भेजकर HTTP Basic Auth का उपयोग करके अनुरोधों को प्रमाणित करें। पासवर्ड खाली छोड़ दें।

API केवल सुरक्षित HTTPS कनेक्शन स्वीकार करता है। सामान्य HTTP अनुरोध अस्वीकार कर दिए जाते हैं, साथ ही ऐसे सभी अनुरोध भी जिनमें उचित प्रमाणीकरण क्रेडेंशियल नहीं हैं।

उदाहरण अनुरोध

curl https://partner-api.performancehub.co/partner/v1/organisations \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# The colon prevents curl from asking for a password.

सीक्रेट कुंजी सत्यापित करें

curl https://partner-api.performancehub.co/partner/v1/auth/ping \
  -u sk_live_YOUR_PARTNER_SECRET_KEY:
# Returns { "message": "You are successfully authorised as <PartnerName>" }