اصلي منځپانګې ته لاړ شئ

د شریکو اپونو لپاره 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>

ځواب یو access_token (له monochat_at_ سره پیلېږي) لري چې د expires_in ثانیو (یو ساعت) لپاره اعتبار لري، یو 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 لپاره د سازمان خپل حد.

تازه کول او لغوه کول​

  • تازه کول: مخکې له دې چې د لاسرسي ټوکن پای ته ورسېږي، د ټوکن endpoint ته د grant_type=refresh_token او refresh_token سره زنګ ووهئ. هر تازه کول نوی د تازه کولو ټوکن راګرځوي؛ نوی یې وکاروئ. د تازه کولو هغه ټوکن چې د بدلېدو له یوې دقیقې ډېر وروسته بیا وکارول شي، اجازه پای ته رسوي.
  • پای ته رسېدل: اجازه د وروستي تازه کولو ۹۰ ورځې وروسته، کله چې کارن یې له نښلول شوي اپونه څخه لغوه کړي، یا کله چې کارن خپل پټنوم بدل یا بیا تنظیم کړي، پای ته رسېږي. بیا کارن باید اپ بیا تایید کړي.
  • لغوه کول: د یو کارن د پرې کولو لپاره، د لاسرسي یا تازه کولو ټوکن د خپل پیرودونکي تصدیق سره د لغوه کولو endpoint ته ولېږئ:
curl -X POST https://app.monochat.ai/oauth/revoke \
-u "<client_id>:<client_secret>" \
-d token=<refresh_token>

ستاسو اپ ته د همغه کارن بیا نښلول د هغه پخوانۍ اجازه بدلوي.