এপিআই অ্যাক্সেস এবং প্রমাণীকরণ

SPREEAI অনুমোদিত অংশীদার ওয়ার্কফ্লোগুলির জন্য একটি পাবলিক এপিআই রেফারেন্স প্রদান করে: https://docs.spreeai.com/swagger/public/.

অ্যাক্সেস মডেল

পার্টনার অনবোর্ডিংয়ের সময় এপিআই-এর পরিধি, পরিবেশ, ক্রেডেনশিয়াল এবং অনুমোদিত অপারেশনগুলো নিয়ে সম্মতি দেওয়া হয়। কোনো অভ্যন্তরীণ, ডেভেলপমেন্ট বা পুরোনো এন্ডপয়েন্ট প্রোডাকশনে পাওয়া যাবে, এমনটা ধরে নেবেন না।

পরিচয়পত্রের নিয়মাবলী

• ক্লায়েন্ট সিক্রেট এবং অ্যাক্সেস টোকেন শুধুমাত্র একটি সুরক্ষিত সার্ভার-সাইড সিক্রেট স্টোরে সংরক্ষণ করুন।
• কখনো গিট, ডকুমেন্টেশন, ইস্যু ট্র্যাকার, স্ক্রিনশট বা স্যাম্পল অ্যাপ্লিকেশনে ক্রেডেনশিয়াল কমিট করবেন না।
• অ্যানালিটিক্স বা লগিং প্ল্যাটফর্মে কখনো ক্রেডেনশিয়াল পাঠাবেন না।
• পরিবেশ-নির্দিষ্ট ক্রেডেনশিয়ালগুলো শুধুমাত্র সেই পরিবেশের সাথেই ব্যবহার করুন যার জন্য সেগুলো ইস্যু করা হয়েছে।
• কোনো পরিচয়পত্র উন্মুক্ত হয়ে গেলে অবিলম্বে তা পরিবর্তন করুন।
• সহায়তা অনুরোধ থেকে অনুমোদন হেডার এবং টোকেন গোপন করুন।

ব্রাউজার বনাম সার্ভার

ওয়েব এসডিকে অংশীদার-প্রদত্ত ব্রাউজার কনফিগারেশন ব্যবহার করে। ব্রাউজারে কোনো ক্লায়েন্ট সিক্রেট অন্তর্ভুক্ত করা যাবে না।

সার্ভার-সাইড ইন্টিগ্রেশনগুলোকে বর্তমান অনুমোদিত এপিআই রেফারেন্সে থাকা অথেনটিকেশন ফ্লো এবং এন্ডপয়েন্ট ডেফিনিশন অনুসরণ করতে হবে। যখন কোনো প্রয়োজনীয় অপারেশন অনুপস্থিত থাকবে, তখন একটি আনডকুমেন্টেড রুট তৈরি না করে পার্টনার ইঞ্জিনিয়ারিং-এর মাধ্যমে সেটির জন্য অনুরোধ করুন।

ওয়েবহুক

সার্ভার-পুশ ওয়েবহুক বর্তমানে প্রকাশিত ওয়েব এসডিকে ডকুমেন্টেশনের অংশ নয়। কোনো ওয়েবহুকের উপর নির্ভরতা ডিজাইন করার আগে সেটির প্রয়োজনীয়তা নিশ্চিত করুন।

পরিবেশগত চেকলিস্ট

• [ ] পরিবেশের নামটি নথিভুক্ত করা আছে।
• [ ] মূল URL-টি অনুমোদিত রেফারেন্স বা অনবোর্ডিং হস্তান্তর থেকে এসেছে।
• [ ] ঐ পরিবেশের জন্য পরিচয়পত্র জারি করা হয়েছিল।
• [ ] গোপনীয় তথ্য সার্ভার-সাইডে সংরক্ষিত থাকে।
• [ ] লগ টোকেন এবং গ্রাহকের ছবি গোপন করে।
• [ ] রাইট অপারেশনের জন্য টাইমআউট, রিট্রাই এবং আইডম্পোটেন্সি আচরণ বিষয়ে সম্মতি জানানো হয়েছে।
• [ ] প্রোডাকশন অ্যাক্সেস ব্যবহার করার আগে একটি নন-প্রোডাকশন টেস্ট সফল হয়।