اسناد API

نحوه اتصال و ادغام با API ما را بیاموزید.

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

احراز هویت

همه نقاط پایانی API به یک کلید API نیاز دارند که توسط روش تأیید اعتبار حامل ارسال شود.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://mybotsy.com/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 کار می کنند، مگر اینکه طور دیگری مشخص شده باشد.
کاربر
تیم ها
اعضای تیم
عضو تیم ها
گزارش‌های حساب