مستندات API

این مستندات مربوط به نقاط پایانی API موجود است که بر اساس معماری REST ساخته شده‌اند. تمام نقاط پایانی API یک پاسخ JSON با کدهای پاسخ استاندارد HTTP برمی‌گردانند و به یک احراز هویت حامل از طریق کلید API نیاز دارند.

کلید API خودتان را دریافت کنید

آدرس اینترنتی پایه

احراز هویت

تمام نقاط پایانی API به یک کلید API نیاز دارند که توسط روش Bearer Authentication ارسال می‌شود.

Authorization: Bearer {api_key}

مثال

curl --request GET \
--url 'https://abzar.app/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

خطاها

API ما از کدهای وضعیت HTTP مرسوم برای نشان دادن موفقیت یا شکست یک درخواست استفاده می‌کند.

مثال

{
    "errors": [
        {
            "title": "\u0634\u0645\u0627 \u0628\u0647 API \u062f\u0633\u062a\u0631\u0633\u06cc \u0646\u062f\u0627\u0631\u06cc\u062f.",
            "status": 401
        }
    ]
}

کدهای وضعیت

200 درخواست با موفقیت انجام شد

400 درخواست نامعتبر - پارامترهای مورد نیاز وجود ندارد یا نامعتبر است

401 غیرمجاز - کلید API موجود نیست یا نامعتبر است

404 منبع مورد نظر یافت نشد

429 درخواست‌ها خیلی زیاد است - محدودیت نرخ از بین رفته است

500 خطای داخلی سرور - این به این معنی است که مشکلی از سمت ما وجود دارد.

تمام نتایج نقطه پایانی API با منطقه زمانی UTC کار می‌کنند، مگر اینکه خلاف آن مشخص شده باشد.

کاربر

گزارش‌های حساب