Authentication

Authentication with the becard.me REST API is achieved through the OAuth 2.0 Bearer Token mechanism. This authentication method ensures the security of your API requests and provides controlled access to the platform's resources.

Include the token in the Authorization header of your API requests as follows:

Authorization: Bearer YOUR_ACCESS_TOKEN

Your Bearer Token allows you to securely access protected resources on the becard.me platform.

---

Follow the steps below to obtain and use your Bearer Token for authentication.

Variant 1: Request an Access Token over Credentials

To access the API, you need to obtain an Access Token by making a POST request to our token endpoint:

POST /v1/auth/login

Headers

Name	Type	Description
Accept*		application/json
Content-Type*		application/json

Request Body

Name	Type	Description
email*	string	Your E-MAIL
password*	string	Your PASSWORD

200: OK Success

{
    "access_token": "eyJ0eXAiOiJKV1Q...",
    "session_id": "ZXlKcGRpSTZJbXc1VjJ...",
    "expires_at": "2024-04-19T22:53:03.000000Z"
}

422: Unprocessable Entity Not found or credentials not match

{
    "message": "Access data do not match!"
}

500: Internal Server Error If no body parameter set

    "message": "Undefined array key \"email\"",
    "exception": "ErrorException",