توکن‌ها و دسترسی‌ها
با توکن شخصی API، ابزارها و دستیارهای خودتان از طرف شما با لُب کار می‌کنند.
حالت توسعه‌دهنده
Section titled “حالت توسعه‌دهنده”توکن‌ها فقط با «حالت توسعه‌دهنده» در دسترس‌اند: در برنامه «حساب» را باز کنید و به بخش «توسعه‌دهندگان» بروید. این حالت برای حساب تازه خاموش است. وقتی روشنش کنید «اتصال‌ها» نمایان می‌شود و توکن‌ها را همان‌جا می‌سازید و مدیریت می‌کنید.
خاموش کردن «حالت توسعه‌دهنده» همهٔ توکن‌های حساب شما را متوقف می‌کند: هر درخواست پاسخ
403 DEVELOPER_MODE_OFF می‌گیرد، اما هیچ توکنی باطل نمی‌شود. وقتی دوباره روشنش کنید، همان
توکن‌ها دوباره کار می‌کنند.
توکن چطور کار می‌کند
Section titled “توکن چطور کار می‌کند”- هر توکن متعلق به یک نفر است، یعنی صاحب حساب، و از طرف همان حساب کار می‌کند: آنچه می‌فرستد از دقیقه‌های همان حساب خرج می‌کند و آنچه می‌خواند از همان حساب است.
- هر درخواست توکن را در هدر
Authorizationمی‌فرستد:Authorization: Bearer $LOBBE_TOKEN. - برنامه توکن را فقط یک بار و هنگام ساختن نشان می‌دهد. لُب فقط هش آن را نگه می‌دارد، پس توکن گم‌شده دوباره نمایش داده نمی‌شود: توکن تازه‌ای بسازید.
- هم‌زمان حداکثر ۱۰ توکن فعال می‌توانید داشته باشید. توکن‌های باطل‌شده و منقضی شمرده نمی‌شوند.
- توکن پس از ۳۰، ۹۰ یا ۳۶۵ روز منقضی می‌شود، یا هرگز («بدون انقضا»). این را هنگام ساختن انتخاب می‌کنید.
- دسترسی‌های توکن هنگام ساختن ثابت می‌شوند. اگر ابزاری دسترسی بیشتر یا کمتری لازم دارد، توکن تازه‌ای بسازید و توکن قبلی را باطل کنید.
- برای باطل کردن توکن، آن را در «اتصال‌ها» باز کنید و دو بار «ابطال» را بزنید. توکن همان لحظه از کار می‌افتد و هر چه پیش‌تر فرستاده در آرشیو شما می‌ماند.
دسترسی‌ها
Section titled “دسترسی‌ها”هر دسترسی یک نوع کار را برای توکن باز می‌کند. فرم ساخت توکن هشت دسترسی را در سه گروه نشان می‌دهد:
- جلسه‌ها:
recordings:read،recordings:write،recordings:query - سری‌ها:
series:read،series:write،series:query - حساب:
account:read،account:write
| دسترسی | در فرم | کاری که می‌کند | مسیرها | دقیقه مصرف می‌کند | کلید روشن‌شدن |
|---|---|---|---|---|---|
recordings:read |
خواندن | فهرست جلسه‌های آماده را می‌گیرد و متن کامل، لُب و وضعیت آن‌ها را می‌خواند. | GET /recordings/ready، GET /recordings/{id}/bundle، GET /recordings/{id}/status، GET /events |
خیر | ندارد |
recordings:write |
ارسال جلسه | فایل صوتی می‌فرستد تا لُب ساخته شود، و می‌تواند نام‌گذاری را رد کند یا جلسهٔ ناموفق را دوباره امتحان کند. | GET /recordings/{id}/status، GET /events، POST /recordings، POST /recordings/{id}/naming، POST /recordings/{id}/retry |
بله | API_WRITE_ENABLED |
recordings:query |
جست‌وجو و پرسش | در جلسه‌ها جست‌وجو می‌کند و از آن‌ها می‌پرسد. | GET /recordings/search، GET /recordings/{id}/ask/quote، POST /recordings/{id}/ask |
بله | API_QUERY_ENABLED |
series:read |
خواندن | فهرست سری‌ها را می‌گیرد و تنظیمات و واژگان آن‌ها را می‌خواند. | GET /series/readable، GET /series/{id}، GET /series/{id}/keyterms |
خیر | ندارد |
series:write |
ساختن و ویرایش | سری می‌سازد و نام، تنظیمات و واژگانش را تغییر می‌دهد. | POST /series، PATCH /series/{id}، PUT /series/{id}/keyterms |
خیر | API_WRITE_ENABLED |
series:query |
پرسش از سری | از همهٔ جلسه‌های آمادهٔ یک سری می‌پرسد. | GET /series/{id}/ask/quote، POST /series/{id}/ask |
بله | API_QUERY_ENABLED |
account:read |
دیدن موجودی و تنظیمات | موجودی، تنظیمات، واژگان و حافظهٔ شما را می‌خواند. | GET /account، GET /account/keyterms، GET /account/memory |
خیر | ندارد |
account:write |
تغییر تنظیمات | تنظیمات و واژگان شما را تغییر می‌دهد و یادداشت‌های حافظه را ویرایش یا حذف می‌کند. | PATCH /account/settings، PUT /account/keyterms، PATCH /account/memory/{id}، DELETE /account/memory/{id} |
خیر | API_WRITE_ENABLED |
- فقط
recordings:read(«خواندن» در گروه «جلسه‌ها») به‌طور پیش‌فرض انتخاب شده است. هیچ دسترسی‌ای اجباری نیست، اما توکن دست‌کم یکی لازم دارد. GET /whoamiبه هر توکنی پاسخ می‌دهد، با هر دسترسی‌ای.- هیچ دسترسی‌ای دسترسی دیگری را در خود ندارد. توکنی که می‌تواند جلسه بفرستد اما نمی‌تواند جلسه‌ها
را بخواند (
recordings:writeبدونrecordings:read) فقط به جلسه‌هایی می‌رسد که خودش فرستاده، و از آن‌ها هم فقط وضعیت و رویدادهایشان را می‌بیند: نه رونوشت، نه لُب، و نه هیچ جلسهٔ دیگری. recordings:queryبدونrecordings:readفهرست جلسه‌ها را نمی‌گیرد و رونوشت و لُب کامل هیچ جلسه‌ای را نمی‌خواند، اما جست‌وجو هر جلسهٔ آمادهٔ شما را با واژه‌هایش پیدا می‌کند و می‌توان از همان جلسه پرسید.
سقف روزانه
Section titled “سقف روزانه”توکنی که می‌تواند دقیقه خرج کند می‌تواند سقف روزانه داشته باشد: بیشترین دقیقه‌ای که در هر ۲۴ ساعت حق دارد خرج کند.
- سقف اختیاری است و پیش‌فرض آن «نامحدود» است. فرم «سقف مصرف روزانه» را فقط وقتی نشان می‌دهد که دسترسی‌ای را انتخاب کنید که دقیقه خرج می‌کند.
- روز در این‌جا یعنی هر ۲۴ ساعت پشت سر هم: هر درخواست با دقیقه‌هایی سنجیده می‌شود که توکن در ۲۴ ساعتِ درست پیش از آن خرج کرده است.
- سقف فقط خرج خود همین توکن را می‌شمارد: هر جلسه‌ای که می‌فرستد، از لحظه‌ای که لُب آن را می‌پذیرد، و هزینهٔ هر پرسش. جلسه‌ای که بعداً حذف کنید همچنان شمرده می‌شود.
- اگر درخواستی توکن را از سقف بگذراند، پاسخ
429 TOKEN_DAILY_CAPمی‌گیرد؛ دقیقه‌ها، سقف‌ها و محدودیت‌ها را ببینید. - سقف را در صفحهٔ توکن در «اتصال‌ها»، زیر «سقف روزانه»، تغییر دهید: یک عدد صحیح از ۱ تا ۱۰۰٬۰۰۰ دقیقه.
کارهایی که هیچ توکنی نمی‌تواند بکند
Section titled “کارهایی که هیچ توکنی نمی‌تواند بکند”هیچ دسترسی‌ای این کارها را به توکن نمی‌دهد؛ این‌ها فقط در خود برنامه و به دست شما انجام می‌شوند:
- حذف جلسه یا سری؛
- نشان دادن چیزی به کس دیگر: لینک‌های اشتراک، دعوت و اعضای سری، فهرست ایمیل‌های سری و ارسال خلاصه با ایمیل؛
- خرید دقیقه و پرداخت‌ها؛
- تغییر نام، شمارهٔ تلفن، ایمیل، گذرواژه یا نشست‌های ورود، و تنظیم «حذف صدا پس از ساخت لُب»؛
- ساختن یا باطل کردن توکن، و روشن یا خاموش کردن «حالت توسعه‌دهنده»؛
- بردن جلسه‌ای که پیش‌تر فرستاده شده به یک سری (توکن می‌تواند جلسه را هنگام فرستادن در یک سری بگذارد).
روشن‌شدن تدریجی
Section titled “روشن‌شدن تدریجی”امن نگه داشتن توکن
Section titled “امن نگه داشتن توکن”- هرگز توکن را در URL نگذارید: آدرس‌ها در لاگ‌ها و تاریخچهٔ مرورگر می‌مانند.
- هرگز توکن را در مخزن کد نگذارید. آن را از یک متغیر محیطی یا جایی امن برای نگه‌داری اطلاعات محرمانه بخوانید.
- هرگز توکن را در پیام‌رسان، گزارش مشکل در مخزن کد یا ایمیل نگذارید، حتی در گفت‌وگو با یک دستیار هوش مصنوعی.
- به هر ابزار توکن جداگانه‌ای بدهید، با کمترین دسترسی‌هایی که لازم دارد و، اگر دقیقه خرج می‌کند، با سقف روزانه. آن‌وقت می‌توانید یکی را باطل کنید بی‌آنکه بقیه از کار بیفتند.
- اگر توکنی لو رفت، همان لحظه آن را در «اتصال‌ها» باطل کنید.