প্রমাণীকরণ ও মৌলিক বিষয়

এই পাতায় ISPbills REST API-এর সাধারণ নিয়ম বর্ণনা করা হয়েছে। টোকেন পাওয়ার পর API v1 রেফারেন্স অথবা API v2 রেফারেন্স দেখুন।

রিকোয়েস্টের নিয়ম

বেস URL:

https://app.ispbills.com/api

JSON রিকোয়েস্টে নিচের হেডার পাঠান:

Accept: application/json
Content-Type: application/json
Authorization: Bearer YOUR_TOKEN

API v1 প্রমাণীকরণ

ইমেইল বা মোবাইল নম্বর username হিসেবে দিয়ে সক্রিয় অপারেটর লগইন করতে পারেন:

POST /api/v1/auth/login
Accept: application/json
Content-Type: application/json

{
  "username": "[email protected]",
  "password": "your-password"
}

সফল রেসপন্সে token, refresh_token এবং user পাওয়া যায়। পরবর্তী রিকোয়েস্টে token বিয়ারার টোকেন হিসেবে ব্যবহার করুন। নতুন টোকেন জোড়ার জন্য:

POST /api/v1/auth/refresh
Accept: application/json
Content-Type: application/json

{
  "refresh_token": "YOUR_REFRESH_TOKEN"
}

অফিশিয়াল ক্লায়েন্ট Google বা Facebook টোকেন দিয়ে POST /api/v1/auth/social ব্যবহার করতে পারে।

API v2 ক্লায়েন্ট ক্রেডেনশিয়াল

Integrations → API Management থেকে v2 ক্লায়েন্ট তৈরি করে Client ID ও Client Secret সংরক্ষণ করুন। টোকেন নিন:

POST /api/v2/auth/token
Accept: application/json
Content-Type: application/json

{
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET"
}

রেসপন্সের access_token দিয়ে সুরক্ষিত রুট কল করুন। টোকেন বাতিল করতে:

POST /api/v2/auth/revoke
Authorization: Bearer YOUR_ACCESS_TOKEN
Accept: application/json

v2 স্কোপ

স্কোপ	অনুমতি
customers:read	গ্রাহক ও সংশ্লিষ্ট বিল, পেমেন্ট, সাবস্ক্রিপশন ও ব্যবহার দেখা
customers:write	গ্রাহক তৈরি, পরিবর্তন ও মুছে ফেলা
sms:send	একক ও ব্রডকাস্ট SMS পাঠানো
*	পূর্ণ অনুমতি; কেবল নিয়ন্ত্রিত ইন্টিগ্রেশনে ব্যবহার করুন

পেজিনেশন

কালেকশন রুট সাধারণত page এবং per_page গ্রহণ করে। অধিকাংশ রুটে প্রতি পাতায় সর্বোচ্চ ১০০ রেকর্ড পাওয়া যায়:

{
  "data": [],
  "total": 0,
  "page": 1,
  "last_page": 0
}

ত্রুটি ও রেট লিমিট

স্ট্যাটাস	অর্থ
401	টোকেন অনুপস্থিত, ভুল বা বাতিল
403	অনুমতি বা স্কোপ নেই
404	রিসোর্স পাওয়া যায়নি
422	ইনপুট ভ্যালিডেশন ব্যর্থ
429	রেট লিমিট অতিক্রম করেছে
500	সার্ভার ত্রুটি

v2 রেট লিমিট রেসপন্সে retry_after সেকেন্ড থাকতে পারে। সেই সময় অপেক্ষা করে ব্যাকঅফসহ পুনরায় চেষ্টা করুন।

ভ্যালিডেশন ব্যর্থ হলে message ও ফিল্ডভিত্তিক errors দেখুন। v1-এর পুরোনো রুটে একক ত্রুটি ফরম্যাট ধরে নেবেন না; আগে HTTP স্ট্যাটাস পরীক্ষা করুন।