API কী

API কী আপনাকে প্রোগ্রাম্যাটিকভাবে badges.ninja REST API অ্যাক্সেস করতে দেয়। আপনার নিজস্ব অ্যাপ্লিকেশন থেকে ব্যাজ তৈরি, ইস্যুয়িং ও পরিচালনা স্বয়ংক্রিয় করতে সেগুলি ব্যবহার করুন।

একটি API কী তৈরি করা

1. সাইডবার থেকে API Keys পৃষ্ঠা খুলুন।
2. Create API Key এ ক্লিক করুন। একটি ইনলাইন ফর্ম খোলে:

3. কী-কে একটি নাম দিন এবং Create এ ক্লিক করুন। সম্পূর্ণ কী একটি সবুজ ব্যানারে একবার প্রকাশিত হয়:

4. অবিলম্বে কী কপি করুন — এটি শুধুমাত্র একবার দেখানো হয়। যদি আপনি এটি হারিয়ে ফেলেন, আপনাকে একটি নতুন তৈরি করতে হবে। ব্যানার বাতিল করার পরে, শুধুমাত্র উপসর্গ সংরক্ষিত থাকে:

অ্যাক্সেস স্কোপ

আপনি যখন একটি কী তৈরি করেন তখন আপনি এটিকে read-only করতে পারেন বা সম্পূর্ণ-অ্যাক্সেস রাখতে পারেন:

স্কোপ	যা অনুমতি দেয়
Full access (ডিফল্ট)	পড়া এবং লেখা — ডেটা তালিকাভুক্ত করা এবং তৈরি, ইস্যু, আপডেট, বা মুছে ফেলা।
Read-only	শুধুমাত্র নিরাপদ GET রিকোয়েস্ট। যেকোনো মিউটেটিং রিকোয়েস্ট (POST, PUT, PATCH, DELETE) 403 Forbidden দিয়ে প্রত্যাখ্যান করা হয়।

যে ইন্টিগ্রেশনগুলির শুধুমাত্র আপনার ডেটা পড়ার প্রয়োজন (রিপোর্টিং, ড্যাশবোর্ড, ব্যাকআপ) সেগুলির জন্য একটি read-only কী ব্যবহার করুন যাতে একটি ফাঁস হওয়া কী কিছু পরিবর্তন করতে না পারে। তৈরি ফর্মে Read-only key টিক দিন; read-only কীগুলি তালিকায় একটি Read-only ব্যাজ দেখায়। স্কোপ থাকার আগে তৈরি করা কীগুলি সম্পূর্ণ অ্যাক্সেস রাখে।

কী ফরম্যাট

API কী bws_ উপসর্গ ব্যবহার করে যার পরে 32-অক্ষরের হেক্স স্ট্রিং থাকে:

bws_a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6

অনুরোধে API কী ব্যবহার

প্রতিটি API অনুরোধের X-Api-Key হেডারে API কী অন্তর্ভুক্ত করুন:

curl -X GET https://api.badges.ninja/issuers \
  -H "X-Api-Key: bws_your_api_key_here"

API প্রমাণীকরণের সম্পূর্ণ বিবরণের জন্য প্রমাণীকরণ পৃষ্ঠা দেখুন।

প্রতি প্ল্যানে কী সীমা

আপনি কতটি API কী তৈরি করতে পারেন তা আপনার প্ল্যানের উপর নির্ভর করে:

প্ল্যান	API কী সীমা
Free	1
Starter ($9/mo)	5
Pro ($29/mo)	20

একটি কী মুছে ফেলা

1. API Keys পৃষ্ঠা খুলুন।
2. আপনি যে কী মুছে ফেলতে চান তা খুঁজুন।
3. Delete এ ক্লিক করুন।
4. মুছে ফেলা নিশ্চিত করুন।

একবার মুছে ফেলা হলে, কী অবিলম্বে কাজ করা বন্ধ করে দেয়। সেই কী ব্যবহার করে এমন যেকোনো অ্যাপ্লিকেশন প্রমাণীকরণ ত্রুটি পাবে।