آزمایش تعاملی API حضور و غیاب
در این صفحه می‌توانید همهٔ endpointها را مستقیماً از مرورگر و با کلید API خودتان فراخوانی و پاسخ آن‌ها را مشاهده کنید. توضیحات، پارامترها و نمونه‌های پاسخ همان سند رسمی API است (OpenAPI 3). برای مفاهیم، قواعد محاسبه و نمونه کد به راهنمای استفاده مراجعه کنید.
نحوهٔ آزمایش
- دکمهٔ احراز هویت (Authorize) را بزنید، کلید API را در بخش
ApiKeyAuthوارد کنید و تأیید نمایید. - یک مسیر را باز کنید؛ ابتدا
whoamiرا برای اطمینان از صحت کلید اجرا کنید. - روی امتحان کن (Try it out) بزنید، پارامترها را پر کنید و اجرا (Execute) را بزنید.
- پاسخ، کد وضعیت، زمان پاسخ و دستور cURL معادل در همان کادر نمایش داده می‌شود.
نکات امنیتی
- کلید فقط در حافظهٔ همین صفحه می‌ماند و با بستن یا تازه‌سازی صفحه پاک می‌شود؛ در مرورگر ذخیره نمی‌شود.
- فقط درخواست‌های
GET(فقط‌خواندنی) قابل ارسال است و درخواست‌ها فقط به همین سرور می‌روند. - هر درخواست مانند فراخوانی عادی API با کلید شما احراز هویت می‌شود و در سقف نرخ درخواست (پیش‌فرض ۱۲۰ در دقیقه) حساب می‌شود.
- کلید یک رمز محرمانه است؛ آن را در رایانهٔ عمومی وارد نکنید.
واژه‌نامهٔ رابط (انگلیسی)
Parameters | پارامترها |
Responses | پاسخ‌ها (کدهای ممکن و نمونه) |
Example Value | نمونهٔ مقدار |
Schema | ساختار فیلدها و نوع آن‌ها |
Server response | پاسخ واقعی سرور به درخواست شما |
Models | مدل‌های داده (پایین صفحه) |