مستندات وبسرویس (API)
این مستندات برای استفاده از وبسرویس REST می باشد.
پاسخ وبسرویس بصورت JSON و استاندارد می باشد و در هنگام فراخوانی باید کلید API بصورت Bearer Authentication ارسال شود.
احراز هویت
همه متد های API برای فراخوانی نیاز هست که کلید API را بصورت Bearer Authentication ارسال نمایید.
Authorization: Bearer {api_key}
curl --request GET \
--url 'https://qr38test.rbsrv.in/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
--url 'https://qr38test.rbsrv.in/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \
خطاها
API ما از کدهای متداول HTTP برای نمایش موفقیت یا شکست درخواستها استفاده میکند.
{
"errors": [
{
"title": "\u0634\u0645\u0627 \u0645\u062c\u0627\u0632 \u0628\u0647 \u0627\u0633\u062a\u0641\u0627\u062f\u0647 \u0627\u0632 API \u0646\u06cc\u0633\u062a\u06cc\u062f",
"status": 401
}
]
}
200 درخواست با موفقیت انجام شد
400 درخواست نامعتبر - پارامترهای ضروری وجود ندارند یا معتبر نیستند
401 عدم احراز هویت - API Key وجود ندارد یا نامعتبر است
404 منبع درخواستی پیدا نشد
429 درخواست بیش از حد - محدودیت نرخ عبور کرده است
500 خطای داخلی سرور - یعنی مشکلی از سمت ما وجود دارد
تمام نتایج نقطه انتهایی API با منطقه زمانی UTC کار میکنند مگر اینکه به طور دیگری مشخص شده باشد.
کاربر
کدهای QR
بارکدها
لینکها
آمار لینک
دامین های دلخواه
لاگ حساب کاربری