Postman API و Postman CLI برای احراز هویت از API key استفاده می‌کنند. کلید API به سرور نشان می‌دهد درخواست از طرف کدام کاربر ارسال شده و به داده‌هایی دسترسی می‌دهد که همان کاربر مجوز استفاده از آن‌ها را دارد.
ساخت Postman API key
- در بالای Postman، وارد Settings > Account settings شوید.
- در تنظیمات حساب، بخش API keys را باز کنید.
- اگر هنوز کلیدی ندارید، گزینه Generate API Key را انتخاب کنید.
- برای کلید یک نام قابل تشخیص وارد کنید و دوباره Generate API Key را بزنید.
- کلید را کپی کنید و در محل امن نگه دارید؛ بعدا برای ارسال درخواست به Postman API به آن نیاز دارید.
مدیریت کلیدها
بعد از ساخت کلید، می‌توانید آن را در صفحه API keys مدیریت کنید. از منوی هر کلید می‌توان عملیات‌هایی مثل regenerate، تغییر نام یا حذف را انجام داد. اگر تیم شما تنظیمات انقضای کلید را فعال کرده باشد، می‌توانید مدت اعتبار کلیدها را هم مشخص کنید. در بعضی تیم‌ها، ادمین ممکن است تغییر این تنظیمات را غیرفعال کرده باشد.
استفاده از API key در درخواست‌ها
برای احراز هویت درخواست‌های Postman API، کلید را در header زیر ارسال کنید:
X-API-Key: YOUR_POSTMAN_API_KEYیک روش کاربردی‌تر این است که کلید را به‌عنوان variable با نام postman-api-key ذخیره کنید. Collection رسمی Postman API می‌تواند از همین variable برای هر فراخوانی استفاده کند.
Collection access key چیست؟
Collection access key برای دادن دسترسی فقط‌خواندنی به یک Collection خاص استفاده می‌شود. هر بار که Collection را با Postman API به اشتراک می‌گذارید، یک collection access key جدید ساخته می‌شود. در صفحه API keys می‌توانید کلیدهای دسترسی Collection را ببینید و در صورت نیاز حذف کنید.
نکته امنیتی
API key را در کد، مخزن عمومی یا پیام‌های تیمی قرار ندهید. اگر کلیدی لو رفت یا دیگر لازم نبود، آن را حذف یا regenerate کنید.
منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.