প্রতিটি Telm API অনুরোধ একটি API কী দিয়ে প্রমাণীকৃত হয় যা tk_live_ দিয়ে শুরু হয় — কখনও আপনার ড্যাশবোর্ড লগইন দিয়ে নয়। আপনার অ্যাকাউন্টে একটি কী তৈরি করুন, এটি Authorization হেডারে একটি Bearer টোকেন হিসেবে পাঠান, এবং এটি আপনি যেসব গ্রুপে অ্যাডমিন সেখানে আপনার অ্যাকাউন্টের পক্ষে কাজ করে। একটি কী ফাঁস হলে ড্যাশবোর্ডে এটি প্রত্যাহার করুন এবং একটি নতুন কী ইস্যু করুন।
1API কী কীভাবে কাজ করে
Telm REST API আপনার ব্রাউজার সেশন ব্যবহার করে না। বরং, প্রতিটি অনুরোধ একটি API কী বহন করে — একটি লম্বা গোপন স্ট্রিং যা tk_live_ উপসর্গ দিয়ে শুরু হয়ে এলোমেলো অক্ষর অনুসরণ করে। কী-টি আপনার অ্যাকাউন্ট শনাক্ত করে এবং কলটি অনুমোদন করে।
আপনি আপনার অ্যাকাউন্ট থেকে কী তৈরি করেন এবং একসঙ্গে একাধিক রাখতে পারেন (উদাহরণস্বরূপ, প্রতি স্ক্রিপ্ট বা সেবার জন্য একটি করে)। পূর্ণ গোপনটি কেবল একবার, তৈরির সময় দেখানো হয়; এরপর ড্যাশবোর্ড একটি কী তার সংক্ষিপ্ত উপসর্গ দিয়ে তালিকাভুক্ত করে (tk_live_ সঙ্গে প্রথম কয়েকটি অক্ষর) যাতে আপনি এটি চিনতে পারেন, আর পূর্ণ মান এরপর আর কখনও রাখা হয় না।
- একটি কী দেখতে tk_live_ এরপর একটি লম্বা এলোমেলো স্ট্রিংয়ের মতো।
- কী আপনার ড্যাশবোর্ডে তৈরি ও পরিচালিত হয়।
- পূর্ণ গোপন কেবল একবার প্রদর্শিত হয় — এটি সঙ্গে সঙ্গে কপি করুন এবং কোথাও নিরাপদে রাখুন।
- একটি কী পাসওয়ার্ডের মতো ভাবুন: যার কাছে এটি আছে সে আপনার হয়ে API কল করতে পারে।
2প্রতিটি অনুরোধের সঙ্গে কী পাঠানো
Bearer স্কিম ব্যবহার করে Authorization হেডারে কী-টি পাঠান। হেডার মান হলো Bearer শব্দ, একটি স্পেস, তারপর আপনার কী — উদাহরণস্বরূপ, Authorization: Bearer tk_live_your_key_here।
যেসব ক্লায়েন্ট সহজে একটি Authorization হেডার সেট করতে পারে না, তাদের জন্য API একটি X-API-Key হেডারেও কী গ্রহণ করে। দুটোই থাকলে Authorization হেডার জেতে। প্রোডাকশনে HTTPS ছাড়া অন্য কিছুর উপর অনুরোধ গ্রহণ করা হয় না।
- পছন্দসই: Authorization: Bearer tk_live_... পাঠান।
- বিকল্প: বদলে X-API-Key হেডারে কী পাঠান।
- প্রতিটি কলের বেস URL হলো api.telm.com/api/public/v1।
- পূর্ণ এন্ডপয়েন্ট তালিকা ও স্কিমা ডেভেলপার পাতায় দেখুন।
3একটি কী কী অ্যাক্সেস করতে পারে
একটি কী কঠোরভাবে আপনার অ্যাকাউন্টের পক্ষে কাজ করে। এটি কেবল সেসব গ্রুপ পড়তে বা বদলাতে পারে যেখানে আপনার অ্যাকাউন্ট একজন অ্যাডমিন — অন্য কোনো গ্রুপকে লক্ষ্য করা অনুরোধ 404 ফেরত দেয়, তাই API কখনও প্রকাশ করে না যে আপনি পরিচালনা করতে পারেন না এমন একটি গ্রুপ আদৌ আছে কিনা।
অ্যাক্সেস লক্ষ্য গ্রুপের প্ল্যানের উপরও নির্ভর করে। স্প্যাম-চেক এন্ডপয়েন্ট প্রতিটি প্ল্যানে দৈনিক কোটার মধ্যে খোলা, আর পূর্ণ API (নিয়ম, সেটিংস, হোয়াইটলিস্ট, জার্নাল, অ্যানালিটিক্স, ব্যাচ চেক ও ওয়েবহুক) সংশ্লিষ্ট গ্রুপে Pro প্ল্যান বা উচ্চতরে উপলব্ধ।
- একটি কী কেবল সেসব গ্রুপ স্পর্শ করতে পারে যেখানে আপনি অ্যাডমিন।
- আপনি পরিচালনা করেন না এমন গ্রুপে অনুরোধ 404 ফেরত দেয়, 403 নয়।
- দৈনিক কোটা আপনার সব কী জুড়ে ভাগ করা, প্রতি অ্যাকাউন্টে গণনা করা।
4কী প্রত্যাহার ও ঘোরানো
একটি কী প্রকাশ পেলে — একটি রিপোজিটরিতে কমিট, একটি চ্যাটে পেস্ট, বা অন্য যেকোনোভাবে ফাঁস — আপনার ড্যাশবোর্ড থেকে এটি অবিলম্বে প্রত্যাহার করুন। প্রত্যাহার সঙ্গে সঙ্গে কার্যকর হয়: প্রত্যাহার করা কী কোনো বিলম্বের পর নয়, সেকেন্ডের মধ্যে কাজ করা থামায়।
যেহেতু দৈনিক কোটা প্রতি অ্যাকাউন্টে ভাগ করা, একটি কী প্রত্যাহার করা আপনার ব্যবহার কাউন্টার রিসেট করে না। নিয়মিত কী ঘোরানো ভালো স্বাস্থ্যবিধি: নতুন কী তৈরি করুন, আপনার সেবায় স্থাপন করুন, এটি কাজ করে তা নিশ্চিত করুন, তারপর পুরনোটি প্রত্যাহার করুন যাতে কোনো ডাউনটাইম না থাকে।
- আপনার ড্যাশবোর্ড থেকে একটি কী প্রত্যাহার করুন; এটি প্রায় সঙ্গে সঙ্গে কাজ করা থামায়।
- শূন্য-ডাউনটাইম ঘোরানোর জন্য প্রথমে বিকল্পটি তৈরি করুন, রোল আউট করুন, তারপর পুরনো কী প্রত্যাহার করুন।
- একটি কী প্রত্যাহার করা আপনার দৈনিক কোটা রিসেট করে না — সেটি মধ্যরাত UTC-তে রিসেট হয়।
5প্রমাণীকরণ ত্রুটি
অনুপস্থিত, ত্রুটিপূর্ণ বা প্রত্যাহার করা কী একটি মেশিন-পাঠযোগ্য ত্রুটি কোড ও একটি মানুষ-পাঠযোগ্য বার্তাসহ 401 ফেরত দেয়। আপনার অনুরোধ হঠাৎ 401 দিয়ে ব্যর্থ হতে শুরু করলে, যাচাই করুন কী-টি প্রত্যাহার হয়নি এবং Authorization হেডার ঠিক Bearer সঙ্গে একটি স্পেস সঙ্গে কী হিসেবে বানান করা।
একটি বৈধ কী যা আপনি পরিচালনা করেন না এমন একটি গ্রুপকে লক্ষ্য করে তা 404 ফেরত দেয়। Pro-এর নিচের প্ল্যানের একটি বৈধ কী যা একটি Pro-শুধু এন্ডপয়েন্ট কল করে তা একটি plan_required কোড ও একটি আপগ্রেড ইঙ্গিতসহ 403 ফেরত দেয়।
- 401 — কী অনুপস্থিত, ত্রুটিপূর্ণ বা প্রত্যাহার করা।
- 404 — লক্ষ্য গ্রুপ নেই বা আপনি এর অ্যাডমিন নন।
- 403 plan_required — এন্ডপয়েন্টের সেই গ্রুপে Pro বা উচ্চতর দরকার।