راهنمای استفاده از Web API

در این راهنما نحوه دسترسی و استفاده از Web APIهای مختلف کی دبلیو رنک توضیح داده شده است. به طور کلی نحوه استفاده از این سرویس شامل مراحل زیر می باشد:

1. ثبت نام در سایت کی دبلیو رنک.
2. مراجعه به منوی خرید API در داشبورد و خرید یکی از پلن های API.
3. ارسال درخواست و دریافت توکن دسترسی.
4. دریافت اطلاعات با استفاده از توکن ایجاد شده.

درخواست دریافت توکن

توکن دسترسی رشته ای از کاراکترها است که برای دسترسی به منابع مورد نیاز استفاده می شود.

برای درخواست توکن دسترسی بایستی شناسه کاربری (Client Id) و رمز کاربری (Client Secret) را از منوی دسترسی API دریافت نمایید. سپس به کمک مراحل زیر نسبت به دریافت توکن دسترسی اقدام نمایید:

• ارسال یک درخواست از نوع POST به آدرس https://kwrank.ir/api/v1/authorize
• اضافه کردن مقادیر شناسه کاربری و رمز کاربری به بدنه (Body) درخواست

curl --location --request POST 'https://kwrank.ir/api/v1/authorize' \
            --form 'client_id="8ud1tc71rjpap3inzhjik30vjala7onk"' \
            --form 'secret_id="uf73stfg2yo5pban8n8kzeiq2jeh8bbb7ctrc6dsyioepf7ktoklwhrgtkv4obhn4f1adoaov30uprobohl3ntvyp2ljsnkxijhsuj4jhwtyxthxak3ielaibylobwjn"'

در پاسخ درخواست ارسالی یک توکن دسترسی با مدت اعتبار نامحدود بازگردانده می شود:

{
    "result": true,
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.Jp5+K8rJD9WQjBmUT4UlhUljMGVEUXRrdDlDa2F4eDhMWExBUFE9PQ==.HKlT+/zDh3ulGLSiScNA4VVOnxfvTMnN7tOxiOIqv14=",
    "token_type": "Bearer",
    "status": 200
}

احراز هویت

تمامی درخواست های ارسالی به Web API کی دبلیو رنک، نیازمند احراز هویت می باشند. جهت احراز هویت کافی است مقدار توکن دسترسی را در سربرگ (Header) درخواست، در کلید Authorization و بعد از مقدار Bearer وارد نمایید:

curl --location --request GET 'https://kwrank.ir/api/v1/domains' \
            --header 'Authorization: Bearer
            eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.Jp5+K8rJD9WQjBmUT4UlhUljMGVEUXRrdDlDa2F4eDhMWExBUFE9PQ==.HKlT+/zDh3ulGLSiScNA4VVOnxfvTMnN7tOxiOIqv14='

آدرس پایه

آدرس پایه Web API کی دبلیو رنک نشانی https://kwrank.ir/api/v1 می باشد.

درخواست ها

Web API کی دبلیو رنک از نوع Restful API با پایانه های مختلف است و منابع داده که از طریق ارسال درخواست های HTTP استاندارد به یک پایانه API در دسترس بوده، شامل موارد زیر می باشد:

پاسخ ها

به طور معمول Web API کی دبلیو رنک داده هایی از نوع JSON را در بدنه پاسخ ارسالی باز می گرداند.