শুরু করুন

প্রমাণীকরণ

প্রতিটি অনুরোধের সঙ্গে আপনার 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."
  }
}