مستندات API

یاد بگیرید چگونه به API TisTos متصل شوید و با آن یکپارچه شوید.

 

احراز هویت

تمام درخواست‌های API نیازمند احراز هویت با استفاده از یک کلید API هستند که از طریق هدر Authorization ارسال می‌شود، همان‌طور که در زیر نشان داده شده است.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://tistos.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 کار می‌کنند مگر اینکه خلاف آن مشخص شده باشد.
کاربر
پیوندها
آمار لینک‌ها
پروژه‌ها
پیکسل‌ها
صفحات Splash
کدهای QR
داده
مدیران اعلان‌ها
دامنه‌های سفارشی
تیم‌ها
اعضای تیم
عضو تیم
پرداخت‌های حساب
لاگ‌های حساب‌های کاربری