مستندات API

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

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

احراز هویت

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

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://push.cheraghestan.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 کار می‌کنند مگر اینکه طور دیگری مشخص شده باشد.
کاربر
وبسایت‌ها
Subscribers
Subscribers statistics
Subscribers logs
Campaigns
اعلان‌های شخصی
خودکارسازی‌های RSS
کمپین‌های تکراری
جریان‌ها
بخش‌ها
مدیران اعلان‌ها
Custom domains
لاگ‌های حساب