सुरु गर्नुहोस्

प्रमाणीकरण

प्रत्येक अनुरोधसँग तपाईंको API कुञ्जी पठाइन्छ। यसले तपाईंको प्रयोगकर्ता चिनाउँछ र प्रतिक्रियामा के आउन सक्छ भन्ने निर्धारण गर्छ।

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

कुञ्जी सर्भरमा मात्र प्रयोग गर्नुहोस्। यसलाई कहिल्यै वेब पृष्ठ, एप वा लिङ्कमा नराख्नुहोस्: URL मा पठाइएका कुञ्जीहरू API ले अस्वीकार गर्छ। प्रत्येक प्रयोगकर्तासँग बढीमा 10 वटा सक्रिय कुञ्जीहरू हुन सक्छन् र उसले नियन्त्रण प्यानलको उही ट्याबमा जुनसुकै कुञ्जी खारेज गर्न सक्छ।

कुञ्जीको ढाँचा

कुञ्जी 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();
Authorization हेडरसहित
curl "https://api.on-cloud.live/v1/me" \
  -H "Authorization: Bearer $API_KEY"
कुञ्जी नभएको वा खारेज गरिएको कुञ्जी401
{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is invalid or has been revoked."
  }
}