نظرة على الواجهة
ثلاث نقاط وصول، تُستدعى من خادمك بمفتاحك السري.
في هذه الصفحة
العنوان الأساسي#
تُرسل كل الطلبات إلى https://api.antiro.io.
المصادقة#
أرسل مفتاحك السري في الرأس X-API-Key مع كل طلب، واستدعِ الواجهة من خادمك فقط.
curl https://api.antiro.io/v1/assessments/<id> \
-H "X-API-Key: $ANTIRO_SECRET_KEY"نقاط الوصول#
| الطريقة | المسار | ما تفعله |
|---|---|---|
POST | /v1/assessments | فحص الطلب |
GET | /v1/assessments/:id | قراءة فحص سابق |
POST | /v1/outcomes | إبلاغ ما وجده فريقك |
الطلبات#
أرسل JSON مع Content-Type: application/json. يتجاهل Antiro الحقول التي لا يعرفها، والنص الأطول من حد الحقل يُقصّ ولا يُرفض: انظر حدود الحقول.
الأجوبة#
كل جواب بصيغة JSON. يعيد POST الناجح الرمز 201، ويعيد GET الناجح الرمز 200. وللأخطاء صيغة واحدة.