Postman API به شما اجازه می‌دهد داده‌های ذخیره‌شده در حساب Postman را با کد بخوانید و مدیریت کنید؛ از جمله Collectionها، APIها، Workspaceها و منابع دیگر. این راهنما مسیر اولین فراخوانی ساده به endpoint /me را توضیح می‌دهد.
قبل از شروع
- یک Postman API key بسازید.
- کلید را در Postman Vault یا یک محل امن مشابه نگه دارید.
- محدودیت نرخ پلن خود را در نظر بگیرید، چون تعداد فراخوانی‌های Postman API محدود است.
ذخیره API key
بعد از ساخت کلید، آن را به‌عنوان secret در Postman Vault ذخیره کنید. این کار باعث می‌شود کلید بین Workspaceهای تیم قابل استفاده باشد، بدون اینکه مقدار حساس آن در Collection یا تاریخچه درخواست‌ها پخش شود.
fork کردن Collection رسمی Postman API
برای اولین درخواست، می‌توانید Collection رسمی Postman API را از api.postman.com fork کنید. Fork یک نسخه قابل تغییر در Workspace شما می‌سازد و Collection اصلی را تغییر نمی‌دهد.
بعد از انتخاب گزینه Run in Postman یا fork، یک نام برای fork وارد کنید و Workspace مقصد را انتخاب کنید. پس از ساخت fork، Postman شما را به Workspace انتخاب‌شده می‌برد.
ارسال اولین درخواست به endpoint /me
- در Collection fork شده، پوشه Users را باز کنید.
- درخواست Get authenticated user را انتخاب کنید. این درخواست endpoint
/meرا صدا می‌زند و اطلاعات مالک API key را برمی‌گرداند. - اگر بدون کلید معتبر روی Send بزنید، پاسخ
401 Unauthorizedمی‌گیرید.
- محیطی را انتخاب کنید که API key را در آن ذخیره کرده‌اید.
- دوباره Send را بزنید. این بار endpoint
/meباید پاسخ موفق برگرداند.
جمع‌بندی
پس از این مرحله، می‌توانید همین الگو را برای endpointهای دیگر Postman API به‌کار ببرید: کلید را امن نگه دارید، درخواست را با header مناسب احراز هویت کنید، و پاسخ‌ها و headerهای محدودیت نرخ را در ابزار خود مدیریت کنید.
منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.