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"
}
}