Postman API به شما اجازه می‌دهد دارایی‌ها و داده‌های Postman را با کد مدیریت کنید و Postman را به ابزارهای توسعه، اتوماسیون و CI/CD وصل کنید. با این API می‌توانید Collectionها، محیط‌ها، مانیتورها، Workspaceها، مشخصات API و داده‌های استفاده را برنامه‌نویسی‌شده بخوانید یا تغییر دهید.
شروع سریع
- مستندات و Collection رسمی Postman API از api.postman.com در دسترس است.
- برای استفاده از endpointها به Postman API key نیاز دارید.
- برای اجرای خودکار در CI/CD می‌توانید Postman API را کنار Postman CLI استفاده کنید.
- فراخوانی‌های Postman API محدودیت نرخ دارند؛ بنابراین در ابزارهای خود retry و کنترل مصرف را در نظر بگیرید.
قابلیت‌های اصلی Postman API
بسته به سطح دسترسی و پلن، Postman API می‌تواند بخش‌های مختلف حساب و تیم شما را پوشش دهد:
- Workspaces: ساخت، مدیریت، پشتیبان‌گیری یا حذف Workspaceها و منابع داخل آن‌ها.
- Collections: ساخت، به‌روزرسانی، انتقال آیتم‌ها، مدیریت fork و pull request و کار با مستندات منتشرشده Collection.
- Environments and variables: مدیریت Environmentها، global variableها و collection variableها برای محیط‌های توسعه، تست و تولید.
- Specifications: مدیریت Spec Hub، تولید Collection از specification و همگام‌سازی Collection و spec با منبع اصلی.
- Mock servers: انجام عملیات CRUD، عمومی یا خصوصی کردن mock server، دیدن callهای دریافتی و مدیریت پاسخ‌های خطای 5XX.
- Monitors: اجرای Collectionها بر اساس رویدادهای pipeline یا دریافت وضعیت runnerهای Private API Monitoring.
- Comments, forks, pull requests: مدیریت همکاری تیمی، forkها، وضعیت merge و pull requestها.
- Users, groups and roles: مشاهده کاربران و گروه‌ها و مدیریت مجوزها در Workspace یا Collection.
- Billing and analytics: دریافت اطلاعات billing، گزارش‌های analytics و الگوهای استفاده برای اتصال به سیستم‌های داخلی.
قابلیت‌های وابسته به پلن
بعضی endpointها فقط در پلن‌های مشخص یا برای تیم‌های Enterprise فعال هستند؛ مثل Teams API، Private API Network API، Tags API، Secret Scanner API، SCIM، API Governance و Audit Logs. قبل از طراحی ابزار داخلی، دسترسی پلن و نقش کاربر را بررسی کنید.
نکته درباره endpointهای منسوخ
endpointهای deprecated در Collection رسمی Postman API مشخص شده‌اند و ممکن است در آینده حذف شوند. برای ابزارهای جدید از endpointهای پشتیبانی‌شده استفاده کنید و وابستگی جدید به endpointهای deprecated نسازید.
منبع آموزشی: Postman Docs، بازنویسی و ساده‌سازی‌شده برای کاربران فارسی‌زبان.