معرفی API

API پیامک irnoti یک وب‌سرویس REST است. تمام درخواست‌ها روی HTTPS انجام می‌شوند و بدنه و پاسخ‌ها با فرمت JSON رد و بدل می‌شوند.

آدرس پایه

https://api.irnoti.com/v1

قالب پاسخ

همهٔ پاسخ‌ها ساختار یکسانی دارند:

{
  "success": true,
  "data": { },
  "message": null
}

در صورت بروز خطا، success برابر false است و کد و توضیح خطا در message و error_code برمی‌گردد. فهرست کامل کدها در بخش «کدهای خطا» آمده است.

محدودیت نرخ درخواست

هر کلید API به‌صورت پیش‌فرض تا ۶۰ درخواست در دقیقه را می‌پذیرد. در صورت عبور، پاسخ 429 Too Many Requests دریافت می‌کنید.