शुरुआत करें

प्रमाणीकरण

हर अनुरोध के साथ आपकी API कुंजी भेजी जाती है। यह आपके उपयोगकर्ता की पहचान करती है और तय करती है कि रिस्पॉन्स में क्या आ सकता है।

1. 1कंट्रोल पैनल में मेरा खाता › API खोलें और कुंजी जनरेट करें पर क्लिक करें। ऐसा नाम दें जिससे याद रहे कि कुंजी कहाँ इस्तेमाल होगी, जैसे “मॉनिटरिंग”।
2. 2कुंजी तुरंत कॉपी करें: सुरक्षा कारणों से यह सिर्फ़ एक बार दिखाई जाती है। अगर खो जाए, तो उसे निरस्त करें और नई कुंजी जनरेट करें।
3. 3कुंजी को X-API-Key हेडर में या Authorization: Bearer के रूप में भेजें।

कुंजी का फ़ॉर्मेट

कुंजी apk_ से शुरू होती है, जिसके बाद 48 कैरेक्टर होते हैं। कंट्रोल पैनल में हर कुंजी का सिर्फ़ शुरुआती हिस्सा दिखता है, जो /me के api_key.prefix फ़ील्ड का ही मान है।

कुंजियाँ निरस्त करना और बदलना

कुंजी निरस्त करते ही उससे किए जाने वाले अनुरोध तुरंत ब्लॉक हो जाते हैं। अपने सिस्टम को रोके बिना कुंजी बदलने के लिए, नई कुंजी जनरेट करें, उसे सर्वर पर बदलें और उसके बाद ही पुरानी कुंजी निरस्त करें।

curl "https://api.on-cloud.live/v1/me" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/me');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/me', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

curl "https://api.on-cloud.live/v1/me" \
  -H "Authorization: Bearer $API_KEY"

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is invalid or has been revoked."
  }
}