کلیدهای API

کلید API به یک اسکریپت یا ابزار اجازه می‌دهد بدون رمز عبور و بدون ورود تعاملی، به‌جای شما API را صدا بزند.

ساخت کلید

1. تنظیمات حساب کاربری را باز کنید و کارت کلیدهای API را پیدا کنید.
2. یک نام بنویسید که بگوید کلید کجا استفاده می‌شود، مثلاً CI deploy key.
3. روی ساخت کلید بزنید.
4. کلید را همان لحظه از نوار نمایش‌داده‌شده کپی کنید. این تنها باری است که کلید کامل نشان داده می‌شود و بعداً قابل نمایش دوباره نیست. سپس انجام شد، کپی کردم را بزنید.

کارت، کلیدهای شما را با نام، زمان آخرین استفاده و تاریخ ایجاد فهرست می‌کند. کلیدی که هرگز استفاده نشده این را نشان می‌دهد.

استفاده از کلید

آن را در هر درخواست به‌صورت توکن Bearer بفرستید:

curl https://veneshcloud.ir/api/orders \
  -H "Authorization: Bearer $VENESH_API_KEY" \
  -H "Accept: application/json"

کلید را در یک متغیر محیطی یا مدیر رمز نگه دارید. هرگز آن را در کد منبع، صفحهٔ وب یا مخزن عمومی نگذارید.

ابطال کلید

روی ابطال در ردیف آن بزنید و تأیید کنید. هر چیزی که از آن کلید استفاده می‌کند بلافاصله از کار می‌افتد و این کار قابل بازگشت نیست. اگر هنوز کلید لازم دارید، کلید جدید بسازید.

کلید می‌تواند هر کاری که نشست واردشدهٔ شما می‌تواند انجام دهد، از جمله ساخت ماشین‌هایی که از کیف پول شما هزینه می‌کنند. برای هر ابزار یک کلید بسازید، نام روشن بگذارید و کلیدهایی را که دیگر استفاده نمی‌کنید یا احتمال لو رفتنشان هست ابطال کنید.