مستندات API

با نحوه اتصال و یکپارچه‌سازی با API ما آشنا شوید.

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

احراز هویت

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

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