bn
ফিনটেক

API ডকুমেন্টেশন

ক্লায়েন্ট সাইট, ব্যাক অফিস এবং সমস্ত প্ল্যাটফর্ম মডিউল ডাটাবেস ফাইলের সাথে API এর মাধ্যমে কাজ করে, সরাসরি নয়। এপিআই ইনকামিং ডেটার অ্যাক্সেস, অখণ্ডতা এবং সঠিকতা নিয়ন্ত্রণ করে।

সাধারণ বিবরণ

API কিভাবে কাজ করে?

API - প্ল্যাটফর্মের মূল নোড

এই ডকুমেন্টেশন নিম্নলিখিত কর্মের জন্য সমস্ত API পদ্ধতি বর্ণনা করে:

  • বস্তুর তালিকা পাওয়া (তালিকা পদ্ধতি)
  • তালিকা ফিল্টারিং (ফিল্টার ডেটা সহ তালিকা পদ্ধতি)
  • একটি বস্তু সম্পর্কে বিস্তারিত তথ্য পাওয়া (পদ্ধতি দেখান)
  • অ্যাড অবজেক্ট ফর্মের জন্য ডেটা পাওয়া (পদ্ধতি যোগ করুন)
  • একটি নতুন বস্তু হিসাবে ডেটা সংরক্ষণ করা হচ্ছে (স্টোর পদ্ধতি)
  • অবজেক্ট আপডেট ফর্মের জন্য ডেটা পাওয়া (সম্পাদনা পদ্ধতি)
  • আপডেট করা বস্তুর ডেটা সংরক্ষণ করা (হালনাগাদ পদ্ধতি)

আইপি ঠিকানা দ্বারা পরীক্ষা করা হচ্ছে

API শুধুমাত্র আইপি ঠিকানাগুলির একটি সীমিত তালিকা থেকে অনুরোধ গ্রহণ করে (উদাহরণস্বরূপ, একটি ক্লায়েন্টের অ্যাকাউন্ট সাইট বা একটি ব্যাক অফিস সাইট থেকে)।

অনুমোদিত তালিকায় নেই এমন একটি আইপি ঠিকানা থেকে API-তে যে কোনো অনুরোধ প্রত্যাখ্যান করা হবে।

এটি API-তে DDoS আক্রমণ, অনুরোধগুলিকে মিথ্যা প্রমাণ করার চেষ্টা এবং হ্যাকার পরীক্ষাগুলি প্রতিরোধ করার জন্য করা হয়৷

ব্যবহারকারীরা সর্বদা প্ল্যাটফর্মের পাবলিক সাইট (গ্রাহকের অফিস বা ব্যাক অফিস) অ্যাক্সেস করে এবং এই সাইটটি নিজেই প্ল্যাটফর্মের API থেকে প্রয়োজনীয় ডেটার জন্য অনুরোধ করে। যেহেতু সাইটের আইপি ঠিকানা ঠিক করা আছে, এটি অনুমোদিত তালিকায় থাকবে।

URL এবং পদ্ধতি

সমস্ত API অনুরোধ নিম্নলিখিত HTTP পদ্ধতি ব্যবহার করে করা হয়:

  • GET তালিকা, প্রদর্শন, যোগ এবং সম্পাদনা জন্য
  • POST দোকানের জন্য
  • PUT আপডেটের জন্য
  • DELETE মুছে ফেলার জন্য

API-এর প্রতিটি বিভাগে একটি URL থাকে যেখানে প্রাসঙ্গিক ডেটা পাওয়ার জন্য অনুরোধ করা হয়।

HTTP অনুরোধ পদ্ধতি প্রতিটি URL এর সামনে নির্দিষ্ট করা আছে।

একটি অনুরোধ পাঠানো হচ্ছে

প্রতিটি API অনুরোধে সর্বদা 4টি ভেরিয়েবল থাকতে হবে:

  1. data (এপিআইয়ের জন্য ডেটা অ্যারের সাথে json স্ট্রিং)
  2. user (বর্তমান ব্যবহারকারী সম্পর্কে ডেটার অ্যারের সাথে json স্ট্রিং)
  3. time (UTC সময় অঞ্চলে বর্তমান সময়)
  4. hash (এপিআই-এর অনুরোধ নিশ্চিতভাবে অনুমোদিত উত্স থেকে এসেছে তা যাচাই করার জন্য একটি হ্যাশ আকারে ডিজিটাল স্বাক্ষর)

API থেকে প্রতিক্রিয়া পাওয়া যাচ্ছে

যদি অনুরোধ সফল হয়, API সর্বদা দুটি ভেরিয়েবল প্রদান করে:

  1. status = true (সফল অবস্থা)
  2. data (এপিআই থেকে ডেটা অ্যারে সহ json স্ট্রিং)

অনুরোধ ব্যর্থ হলে, API ভেরিয়েবলগুলি দেখায়:

  1. status = false (ত্রুটির অবস্থা)
  2. error (ত্রুটি বর্ণনা করে পাঠ্য স্ট্রিং)

ডিজিটাল স্বাক্ষর

প্রতিটি API অনুরোধে একটি হ্যাশ ভেরিয়েবল থাকতে হবে যা অনুরোধের ডিজিটাল স্বাক্ষর।

hash = md5($json . $time . $salt)

  • md5, sha256, bcrypt — উপলব্ধ এনক্রিপশন অ্যালগরিদম
  • $json — অনুরোধ ডেটা সহ json স্ট্রিং
  • $time — "DD.MM.YYYY HH:MM:SS" ফর্ম্যাটে সময়
  • $salt — প্ল্যাটফর্ম API-এর জন্য নির্দিষ্ট অনন্য মান ("লবণ")

ফিনটেক

ডকুমেন্টেশনে বাস্তব API অনুরোধের উদাহরণ রয়েছে