توکن‌های API
توکن API کلیدی است که به برنامه‌ها، اسکریپت‌ها و ابزارهای CI/CD اجازه می‌دهد بدون ورود به پنل، از طریق API داده‌هات منابع یک پروژه را مدیریت کنند. در این راهنما شیوه‌ی ساخت، تعیین دسترسی، چرخش و ابطال توکن‌ها در پنل را بررسی می‌کنیم.
ویژگی‌های توکن
توکن‌های API در داده‌هات ویژگی‌های زیر را دارند:
- وابسته به پروژه: هر توکن تنها به یک پروژه، یعنی پروژه‌ای که در آن ساخته شده است، دسترسی دارد.
- به نام سازنده: توکن با هویت و نقش عضوی که آن را ساخته است عمل می‌کند و دسترسی آن هرگز از نقش سازنده در پروژه بیش‌تر نمی‌شود. برای آشنایی با نقش‌ها، راهنمای اعضا و نقش‌ها را ببینید.
- دسترسی محدود: برای هر توکن مشخص می‌کنید به کدام منابع و با چه سطحی دسترسی داشته باشد.
- نمایش یک‌باره: سکرت توکن تنها یک بار، هنگام ساخت، نمایش داده می‌شود.
ساخت توکن
برای ساخت توکن، پس از ورود به پنل کاربری داده‌هات، از منوی سمت راست و گروه «امنیت» گزینه‌ی «توکن‌ها» را انتخاب کنید. در زبانه‌ی «توکن‌ها» روی دکمه‌ی «ساخت توکن» کلیک کنید و فیلدهای زیر را تکمیل کنید:
- نام: یک نام تا ۶۴ کاراکتر، شامل حروف کوچک انگلیسی، عدد، نقطه، زیرخط و خط تیره، مانند ci-deploy. نام باید میان توکن‌های فعال پروژه یکتا باشد.
- دسترسی‌ها: سطح دسترسی توکن را مطابق بخش بعد تعیین کنید.
پس از ساخت، پنجره‌ی «توکن ساخته شد» سکرت توکن را نمایش می‌دهد.
سکرت را همین حالا کپی کنید و در جای امنی نگه دارید. سکرت فقط همین یک بار نمایش داده می‌شود و بعداً قابل بازیابی نیست.
تعیین دسترسی‌ها
دسترسی توکن به یکی از دو شکل زیر تعیین می‌شود:
- دسترسی کامل (*): توکن به همه‌ی منابع پروژه، در حد نقش سازنده، دسترسی دارد.
- دسترسی انتخابی: برای هر نوع منبع، یکی از سطح‌های «مشاهده» (read) یا «مدیریت» (write) را انتخاب می‌کنید. سطح «مدیریت» شامل «مشاهده» نیز می‌شود.
منابعی که در جدول دسترسی‌ها قابل انتخاب هستند، از جمله موارد زیر است:
| منبع | نام دسترسی |
|---|---|
| پروژه | project |
| سرورهای مجازی | vm |
| والیوم‌ها | volume |
| اسنپ‌شات‌ها | snapshot |
| کانتینرها | container |
| شبکه | network |
| رجیستری‌ها | registry |
| کلیدهای SSH | ssh-key |
| بیلدهای CI/CD | build |
| اپلیکیشن‌های بازار | app |
| فضای ابری | bucket |
پیشنهاد می‌شود برای هر کاربرد یک توکن جداگانه با کم‌ترین دسترسی لازم بسازید. برای مثال، توکنی که فقط وضعیت سرورها را می‌خواند، تنها به دسترسی «مشاهده» روی vm نیاز دارد.
چرخش توکن
اگر گمان می‌کنید سکرت یک توکن افشا شده است، یا می‌خواهید سکرت‌ها را به‌شکل دوره‌ای تعویض کنید، از گزینه‌ی «چرخش توکن» استفاده کنید. با چرخش، سکرت جدیدی صادر می‌شود و سکرت قبلی بلافاصله از کار می‌افتد. سکرت جدید نیز تنها یک بار نمایش داده می‌شود.
توجه داشته باشید که تنها عضوی که توکن را ساخته است می‌تواند آن را بچرخاند.
ابطال توکن
برای غیرفعال کردن دائمی یک توکن، گزینه‌ی «ابطال توکن» را انتخاب کنید و درخواست را تأیید کنید. کلاینت‌هایی که از این توکن استفاده می‌کنند بلافاصله دسترسی خود را از دست می‌دهند. مالک، مدیر و ویرایشگر پروژه می‌توانند هر توکن پروژه را باطل کنند.
محدودیت‌های توکن
توکن‌های API برای مدیریت منابع پروژه طراحی شده‌اند و به بخش‌های مربوط به حساب شخصی دسترسی ندارند. عملیات‌های زیر تنها از طریق پنل کاربری امکان‌پذیر است:
- کیف پول، افزایش اعتبار و تراکنش‌ها
- احراز هویت
- اعلان‌ها
- تیکت‌های پشتیبانی
- گزارش رخدادها
استفاده از توکن
برای آشنایی با شیوه‌ی ارسال توکن در درخواست‌های API و پیام‌های خطای مرتبط، راهنمای احراز هویت در API را ببینید.
کلیدهای S3
در صفحه‌ی «توکن‌ها»، زبانه‌ی «کلیدهای S3» نیز قرار دارد که برای دسترسی به فضای ابری با ابزارهای سازگار با S3 استفاده می‌شود. این کلیدها با توکن‌های API متفاوت هستند. برای جزئیات، راهنمای کلیدهای دسترسی S3 را ببینید.