স্কিপ করে মূল কন্টেন্ট এ যান

পার্টনার অ্যাপের জন্য OAuth

কোনো পার্টনার অ্যাপ, অটোমেশন টুল বা কাস্টম অ্যাপ যা কোনো MonoChat ব্যবহারকারীর হয়ে কাজ করে, সেটি কাস্টম ফাংশন API (POST https://app.monochat.ai/api/<slug>/custom-functions/<path>) API টোকেনের বদলে OAuth অ্যাক্সেস টোকেন দিয়ে কল করতে পারে। ব্যবহারকারী MonoChat-এর একটি পেজে অ্যাপটি অনুমোদন করেন, অ্যাপটি কোন প্রতিষ্ঠানগুলোতে পৌঁছাতে পারবে তা বেছে নেন, এবং প্রোফাইল সেটিংসের সংযুক্ত অ্যাপ থেকে যেকোনো সময় এটি বাতিল করতে পারেন।

API টোকেন একই endpoint-এ কাজ করতে থাকে। OAuth হলো অন্যদের হয়ে কাজ করা অ্যাপের বিকল্প: অ্যাপটি কখনো পাসওয়ার্ড বা API টোকেন দেখে না, আর প্রত্যেক ব্যবহারকারী নিজেই এর সংযোগ কেটে দিতে পারেন।

অ্যাপটি ব্যবহারকারী হিসেবে কাজ করে

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

ক্লায়েন্ট নিন​

আপনার অ্যাপের জন্য MonoChat-এর কাছে একটি ক্লায়েন্ট চান। MonoChat এটি যেসব তথ্য দিয়ে নিবন্ধন করে:

  • অ্যাপের নাম, যা অনুমোদন পেজ ও সংযুক্ত অ্যাপ দেখায়;
  • এর রিডাইরেক্ট URI, হুবহু মিলিয়ে: https ঠিকানা, অথবা localhost, 127.0.0.1 বা [::1]-এ http (যেকোনো পোর্ট);
  • যেসব স্কোপ এটি চাইতে পারে: এই API-এর জন্য custom-functions:run।

আপনি একটি ক্লায়েন্ট ID (monochat_rc_ দিয়ে শুরু) এবং একটি ক্লায়েন্ট সিক্রেট (monochat_cs_ দিয়ে শুরু) পান। সিক্রেট শুধু একবার দেখানো হয়; MonoChat শুধু এর হ্যাশ সংরক্ষণ করে। এটি আপনার সার্ভারে রাখুন, কখনো ব্রাউজার বা মোবাইল অ্যাপে নয়।

যে অ্যাপ সিক্রেট গোপন রাখতে পারে না, যেমন ব্রাউজারে বা ব্যবহারকারীর কম্পিউটারে চলা অ্যাপ, সেটি MCP ক্লায়েন্টের মতো একটি ক্লায়েন্ট ID মেটাডেটা ডকুমেন্টের URL ক্লায়েন্ট ID হিসেবে ব্যবহার করতে পারে। তখন এটি কোনো সিক্রেট পাঠায় না।

Endpoint​

https://app.monochat.ai/.well-known/oauth-authorization-server-এর অথরাইজেশন সার্ভার মেটাডেটা সব endpoint তালিকা করে। হোয়াইট-লেবেল বা নিজে হোস্ট করা ইনস্টলেশনে সেই ইনস্টলেশনের নিজস্ব ঠিকানা ব্যবহার করুন।

সেটিংমান
অথরাইজেশন endpointhttps://app.monochat.ai/oauth/authorize
টোকেন endpointhttps://app.monochat.ai/oauth/token
বাতিল endpointhttps://app.monochat.ai/oauth/revoke
রিসোর্সhttps://app.monochat.ai/api/custom-functions
স্কোপcustom-functions:run
ক্লায়েন্ট প্রমাণীকরণHTTP Basic, অথবা অনুরোধের বডিতে client_id ও client_secret

রিসোর্সের নিজস্ব মেটাডেটা আছে https://app.monochat.ai/.well-known/oauth-protected-resource/api/custom-functions-এ।

একজন ব্যবহারকারীকে সংযুক্ত করুন​

MonoChat PKCE (S256) সহ অথরাইজেশন কোড ফ্লো ব্যবহার করে। ব্যবহারকারীর দুই-ধাপের যাচাই (ইমেইল বা অথেনটিকেটর অ্যাপ দিয়ে) চালু থাকতে হবে।

  1. ব্যবহারকারীকে অথরাইজেশন endpoint-এ পাঠান response_type=code, আপনার client_id, নিবন্ধিত একটি redirect_uri, scope=custom-functions:run, resource=https://app.monochat.ai/api/custom-functions, একটি state এবং code_challenge_method=S256 সহ একটি code_challenge দিয়ে।
  2. প্রয়োজনে ব্যবহারকারী MonoChat-এ সাইন ইন করেন। অনুমোদন পেজ আপনার অ্যাপের নাম ও আপনার হয়ে কাস্টম মেথড চালানো দেখায়। ব্যবহারকারী অ্যাপটি কোন সংস্থা-এ পৌঁছাতে পারবে তা বেছে নিতে পারেন (কিছু না বাছলে সব), ৬ অঙ্কের নিশ্চিতকরণ কোড দেন এবং অনুমতি দিন-এ ক্লিক করেন।
  3. MonoChat ব্যবহারকারীকে code, state ও iss সহ আপনার redirect_uri-তে ফেরত পাঠায়। ব্যবহারকারী প্রত্যাখ্যান করুন-এ ক্লিক করলে এর বদলে error=access_denied পাঠানো হয়।
  4. ৫ মিনিটের মধ্যে টোকেন endpoint-এ কোডটি বিনিময় করুন:
curl -X POST https://app.monochat.ai/oauth/token \
-u "<client_id>:<client_secret>" \
-d grant_type=authorization_code \
-d code=<code> \
-d redirect_uri=<redirect_uri> \
-d code_verifier=<code_verifier>

উত্তরে থাকে expires_in সেকেন্ড (এক ঘণ্টা) বৈধ একটি access_token (monochat_at_ দিয়ে শুরু), একটি refresh_token (monochat_rt_ দিয়ে শুরু) এবং প্রদত্ত scope।

API কল করুন​

অ্যাক্সেস টোকেনটি bearer টোকেন হিসেবে পাঠান:

curl -X POST https://app.monochat.ai/api/<slug>/custom-functions/<path> \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{}'
স্ট্যাটাসকখন
401টোকেনটি অজানা, মেয়াদোত্তীর্ণ বা বাতিল, অথবা অন্য কোনো রিসোর্সের জন্য, যেমন MCP সার্ভার, ইস্যু করা। WWW-Authenticate হেডার রিসোর্স মেটাডেটা দেখায়।
403প্রতিষ্ঠানটি ব্যবহারকারী অ্যাপের জন্য যেগুলোর অনুমতি দিয়েছেন তার মধ্যে নেই, প্রতিষ্ঠানে ব্যবহারকারীর অ্যাক্সেস নেই, অথবা অনুমতিতে custom-functions:run নেই।
429একটি সীমা পূর্ণ হয়েছে; Retry-After-এর সেকেন্ড পর্যন্ত অপেক্ষা করুন। কল প্রতি মিনিটে গোনা হয়: প্রতি অনুমতিতে 120 এবং প্রতি ক্লায়েন্টে 1,200, এই endpoint-এর জন্য প্রতিষ্ঠানের নিজস্ব সীমার পাশাপাশি।

রিফ্রেশ ও বাতিল​

  • রিফ্রেশ: অ্যাক্সেস টোকেনের মেয়াদ শেষ হওয়ার আগে grant_type=refresh_token ও refresh_token দিয়ে টোকেন endpoint কল করুন। প্রতিটি রিফ্রেশ নতুন রিফ্রেশ টোকেন ফেরত দেয়; নতুনটি ব্যবহার করুন। প্রতিস্থাপিত হওয়ার এক মিনিটের বেশি পরে আবার ব্যবহৃত রিফ্রেশ টোকেন অনুমতিটি শেষ করে দেয়।
  • মেয়াদ: অনুমতি শেষ হয় শেষ রিফ্রেশের ৯০ দিন পরে, যখন ব্যবহারকারী সংযুক্ত অ্যাপ থেকে এটি বাতিল করেন, অথবা যখন ব্যবহারকারী পাসওয়ার্ড পরিবর্তন বা রিসেট করেন। তখন ব্যবহারকারীকে আবার অ্যাপটি অনুমোদন করতে হয়।
  • বাতিল: কোনো ব্যবহারকারীর সংযোগ কাটতে আপনার ক্লায়েন্ট প্রমাণীকরণসহ অ্যাক্সেস বা রিফ্রেশ টোকেন বাতিল endpoint-এ পাঠান:
curl -X POST https://app.monochat.ai/oauth/revoke \
-u "<client_id>:<client_secret>" \
-d token=<refresh_token>

একই ব্যবহারকারীকে আবার আপনার অ্যাপে সংযুক্ত করলে তাঁর আগের অনুমতি প্রতিস্থাপিত হয়।