AGENTREADY / DOCS
راهنمای API
وب و API از یک قرارداد گزارش استفاده میکنند. گزارشهای قدیمی همچنان با شناسه قبلی قابل خواندناند.
ثبت بررسی
POST /api/v1/audits با بدنه JSON شامل url بررسی را ثبت میکند. پاسخ ۲۰۲ یعنی بررسی در حال اجراست. شناسه id و مسیر api_url را برای خواندن نتیجه نگه دارید. درخواست نوشتن باید از مبدأ مجاز سایت ارسال شود.
خواندن گزارش
GET /api/v1/audits/{id} وضعیت و گزارش را برمیگرداند. تا زمانی که وضعیت queued یا running است، با فاصله دستکم دو ثانیه نتیجه را بخوانید. وضعیت completed گزارش کامل و failed علت شکست را دارد.
دامنهها
GET /api/v1/domains از پارامترهای page، q، limit و sort برای صفحهبندی، جستوجو و مرتبسازی پشتیبانی میکند. sort میتواند newest، best، worst، unavailable، most_scanned یا biggest_change باشد. هر دامنه علاوه بر آخرین وضعیت و امتیاز، تعداد اسکنهای نگهداریشده و تغییر امتیاز نسبت به بررسی قبلی را هم برمیگرداند. GET /api/v1/sites/{hostname} تاریخچه همان دامنه را میدهد.
نسخه و محدودیت
قالب گزارش 1.2 و معیارها agentready@1.0.0 هستند. پاسخ ۴۲۹ یعنی باید تعداد درخواست را کم کنید. کلید API برای اتصال ماشینی حسابها در این نسخه ارائه نشده است.