Onliner User API

https://docs.onliner.by/user/
Admin
Onliner User API is an authentication service that handles user login with support for two-factor...
Tokens:1,053
Snippets:3
Trust Score:10
Update:10 months ago
Show doc for...
Tokens:
Raw
### POST /login

Source: https://docs.onliner.by/user/index

Authenticates a user by their login credentials. Supports two-factor authentication if enabled.

```APIDOC
## POST /login

### Description
Authenticates a user by their login credentials. If two-factor authentication is enabled and the device is untrusted, an SMS code will be requested.

### Method
POST

### Endpoint
https://user.api.onliner.by/login

### Parameters
#### Header Parameters
- **Content-Type** (string) - Required - Example: application/json

#### Request Body
- **login** (string) - Required - E-mail or username
- **password** (string) - Required - User's password

### Request Example
```json
{
  "login": "my_user",
  "password": "my_password"
}
```

### Response
#### Success Response (200)
- **expires_in** (integer) - The expiration time of the token in seconds.
- **access_token** (string) - The authentication token.
- **refresh_token** (string) - The token used to refresh the access token.

#### Response Example
```json
{
  "expires_in": 315360000,
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJ1c2VyIiwidXNlcl9kYXRhIjp7ImlkIjoxLCJuYW1lIjoidXNlcjEiLCJlbWFpbCI6ImVtYWlsMUBvbmxpbmVyLmJ5Iiwic3RhdHVzIjoiYWN0aXZlIiwicm9sZXMiOltdLCJzbXNfdmFsaWRhdGlvbl9zdGF0dXMiOiJub3RfdmFsaWRhdGVkIn0sImlhdCI6MTUzODM4NDQwMCwic2NvcGVzIjpbXSwiZXhwIjoxNTM4Mzg1MDAwfQ.lzasqn5hMnrPDLxDa4Naow_HrXehwk4GTRFKHzKZVsnz3tztolZio6Y8hRfBd1J5gUuUkU8gA5ictxvRuSk51A",
  "refresh_token": "31c1425e64242578c98f28ebaa5e629f"
}
```

#### Error Responses
- **400** - Bad Request
- **422** - Unprocessable Entity (Validation Errors)
- **429** - Too Many Requests
```

--------------------------------

### User Authentication Response Sample (200 OK)

Source: https://docs.onliner.by/user/index

This snippet shows a successful response (HTTP 200 OK) after user authentication. It contains tokens necessary for subsequent API interactions, such as 'access_token' and 'refresh_token', along with their expiration times.

```json
{
  "expires_in": 315360000,
  "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJ1c2VyX2lkIjoxLCJ1c2VyX3R5cGUiOiJ1c2VyIiwidXNlcl9kYXRhIjp7ImlkIjoxLCJuYW1lIjoidXNlcjEiLCJlbWFpbCI6ImVtYWlsMUBvbmxpbmVyLmJ5Iiwic3RhdHVzIjoiYWN0aXZlIiwicm9sZXMiOltdLCJzbXNfdmFsaWRhdGlvbl9zdGF0dXMiOiJub3RfdmFsaWRhdGVkIn0sImlhdCI6MTUzODM4NDQwMCwic2NvcGVzIjpbXSwiZXhwIjoxNTM4Mzg1MDAwfQ.lzasqn5hMnrPDLxDa4Naow_HrXehwk4GTRFKHzKZVsnz3tztolZio6Y8hRfBd1J5gUuUkU8gA5ictxvRuSk51A",
  "refresh_token": "31c1425e64242578c98f28ebaa5e629f"
}
```

--------------------------------

### User Authentication Request Sample (PHP)

Source: https://docs.onliner.by/user/index

This snippet demonstrates the structure of a request payload for user authentication using the User API. It includes the login credentials required for the POST /login endpoint. Ensure the 'Content-Type' header is set to 'application/json'.

```json
{
  "login": "my_user",
  "password": "my_password"
}
```
Tokens:
Raw