B2COPY API از مجوز bearer-token استفاده می کند. برای دریافت یک جفت نشانه دسترسی/بازخوانی، روش ورود به سیستم زیر را فراخوانی کنید، سپس رمز دسترسی را در سربرگ Authorization: Bearer <token> هر درخواست بعدی قرار دهید.
پیش نیاز
برای به دست آوردن توکن ها باید قبلاً در Back Office ثبت نام کرده باشید و برای دسترسی به آن اعتبار داشته باشید.
نقطه پایانی
POST [host]/api/v2/signinدرخواست بدن
| نام | تایپ کنید | مورد نیاز | توضیحات |
|---|---|---|---|
| رشته | بله | آدرس ایمیل استفاده شده برای دسترسی به Back Office. | |
| password | رشته | بله | رمز عبور استفاده شده برای دسترسی به Back Office. |
curl --location --request POST 'https://host.name/api/v2/signin' \
--data-raw '{
"email": "username@example.com",
"password": "Secret123"
}'پاسخ
پاسخ یک جفت توکن دسترسی و بازخوانی را برمیگرداند که هر کدام دارای یک رشته توکن و مُهرهای createdAt / expiresAt هستند.
{
"2faRequired": false,
"accessToken": {
"token": "eyJ0eXAiOiJKV1Qi…",
"createdAt": "2024-01-01T00:00:00+00:00",
"expiresAt": "2024-01-01T00:00:00+00:00"
},
"refreshToken": {
"token": "eyJ0eXAiOiJKV1Qi…",
"createdAt": "2024-01-01T00:00:00+00:00",
"expiresAt": "2024-01-01T00:00:00+00:00"
}
}