مستندات ویرالینک

Administration REST API

Swagger UI #

با Swagger UI می‌توانید REST API های ویرالینک را مشاهده و آزمایش کنید.

برای ورود بر روی لینک زیر کلیک کنید.

https://console.viralink.io/swagger-ui.html

اعتبارسنجی REST API #

ویرالینک برای اعتبارسنجی درخواست‌ها از JWT استفاده می‌کند. برای استفاده از rest api باید با دکمه «Authorize» هدر «X-Authorization» را با شناسه دریافتی از روش زیر پر کنید.

برای اینکه توکن JWT را بدست بیاورید، باید درخواست زیر را اجرا نمایید.

همچنین در پروفایل گزینه Copy JWT Token را برای swagger و تست می توانید استفاده کنید.

در صورتی که برای اولین بار از api استفاده خواهید کرد ابتدا رمز عبور کنسول را ایجاد کنید.

  • ابتدا به پروفایل خود در کنسول در قسمت گوشه بالا سمت راست وارد شوید.
  • بر روی دکمه تغییر رمز عبور بزنید و برای خود رمزی تعیین کنید. اگر برای اولین بار است که میخواهید رمز عبور خود را تغییر دهید و در زمان ثبت نام در سایت پسورد خود را وارد نکرده اید قسمت رمز عبور فعلی را خالی بگذارید.

به جای tenant@viralink.io نام کاربری(ایمیل) و به جای رمز عبور tenant رمز عبور خودتان را وارد نمایید.

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"username":"tenant@viralink.io", "password":"tenant"}' 'https://console.viralink.io/api/auth/login'
{"token":"$YOUR_JWT_TOKEN", "refreshToken":"$YOUR_JWT_REFRESH_TOKEN"}

حال برای تمامی درخواست‌های rest هدر «X-Authorization» با مقدار «Bearer $YOUR_JWT_TOKEN» پرکنید.

برای استفاده از Refresh Token جهت دریافت توکن جدید به جای $YOUR-LAST-REFRESH-TOKEN رفرش توکنی که در مرحله قبل (آخرین بار) دریافت کردید را جایگذاری نمایید.

curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' -d '{"refreshToken":"$YOUR-LAST-REFRESH-TOKEN"}' 'https://console.viralink.io/api/auth/token'