¶ Plusofon API — пользователи
версия от 2023-02-13
Группа методов позволяет управлять пользователями личного кабинета Плюсофон.
Адрес: https://restapi.plusofon.ru
¶ Получение списка
GET api/v1/user
Метод позволяет получить список всех пользователей текущего личного кабинета.
¶ Параметры и примеры запроса
Не имеет параметров.
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/user" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}"
const url = new URL(
"https://restapi.plusofon.ru/api/v1/user"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://restapi.plusofon.ru/api/v1/user',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/user'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается массив data:
-
id
ИД пользователя в системе -
email
эл. адрес пользователя -
phone
номер телефона -
first_name
имя пользователя -
last_name
фамилия пользователя (при наличии) -
middle_name
отчество пользователя (при наличии) -
roles
массив доступов пользователя-
/
name
код уровня доступа
-
/
client_id
код приложения (для ЛК Плюсофон всегда "10553")
-
возможные варианты поля roles / name:
-
lk_user
обычный («пользователь») -
lk_admin
привилегированный («администратор»)
{
{
"current_page": 1,
"data": [
{
"id": 46,
"email": "test_0053@plusofontest.ru",
"phone": "79991230053",
"first_name": null,
"last_name": null,
"middle_name": null,
"roles": [
{
"name": "lk_admin",
"client_id": 10553
}
]
},
{
"id": 47,
"email": "test_0054@plusofontest.ru",
"phone": "79991230054",
"first_name": null,
"last_name": null,
"middle_name": null,
"roles": [
{
"name": "lk_user",
"client_id": 10553
}
]
}
],
"first_page_url": "http:\/\/localhost\/api\/v1\/user?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http:\/\/localhost\/api\/v1\/user?page=1",
"next_page_url": null,
"path": "http:\/\/localhost\/api\/v1\/user",
"per_page": 15,
"prev_page_url": null,
"to": 2,
"total": 2,
"success": true
}
}
¶ Получение данных
GET api/v1/user/{user_id}
Метод позволяет получить данные конкретного пользователя.
¶ Параметры и примеры запроса
user_idpath
ИД пользователя
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/user/150" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}"
const url = new URL(
"https://restapi.plusofon.ru/api/v1/user/150"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->get(
'https://restapi.plusofon.ru/api/v1/user/150',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/user/150'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается:
-
id
ИД пользователя в системе -
email
эл. адрес пользователя -
phone
номер телефона -
first_name
имя пользователя -
last_name
фамилия пользователя (при наличии) -
middle_name
отчество пользователя (при наличии) -
roles
массив доступов пользователя-
/
name
код уровня доступа -
/
client_id
код приложения (для ЛК Плюсофон всегда "10553")
-
возможные варианты поля roles / name:
-
lk_user
обычный («пользователь») -
lk_admin
привилегированный («администратор»)
Получены данные пользователя:
{
"id": 46,
"email": "test_0053@mail.ru",
"phone": "79993332210",
"first_name": null,
"last_name": null,
"middle_name": null,
"roles": [
{
"name": "lk_admin",
"client_id": 10553
}
],
"success": true
}
¶ Добавление
POST api/v1/user
Метод позволяет создать нового пользователя.
¶ Параметры и примеры запроса
-
emailstring
эл. адрес пользователя -
phonestring
мобильный телефон пользователя -
first_namestring
имя -
last_namestring
фамилия -
middle_namestring
отчество -
rolestring
код уровня доступа
возможные варианты параметра role:
-
lk_user
обычный («пользователь») -
lk_admin
привилегированный («администратор»)
curl -X POST \
"https://restapi.plusofon.ru/api/v1/user" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"email":"user@plusofon.ru","phone":"79993332210","first_name":"Ivan","last_name":"Ivanov","middle_name":"Ivanovich","role":"lk_user"}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/user"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"email": "user@plusofon.ru",
"phone": "79993332210",
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"role": "lk_user"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->post(
'https://restapi.plusofon.ru/api/v1/user',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'email' => 'user@plusofon.ru',
'phone' => '79993332210',
'first_name' => 'Ivan',
'last_name' => 'Ivanov',
'middle_name' => 'Ivanovich',
'role' => 'lk_user',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/user'
payload = {
"email": "user@plusofon.ru",
"phone": "79993332210",
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"role": "lk_user"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
¶ Структура и примеры ответа
В ответе возвращается:
password
пароль для входа в личный кабинет
{
"password": "rDfhgX3j",
"success": true
}
¶ Обновление
PUT api/v1/user/{user_id}
Метод позволяет изменить данные конкретного пользователя.
¶ Параметры и примеры запроса
-
user_idpath
ИД пользователя -
emailstring
эл. адрес пользователя -
phonestring
мобильный телефон пользователя -
first_namestring
имя -
last_namestring
фамилия -
middle_namestring
отчество -
rolestring
код уровня доступа
возможные варианты параметра role:
-
lk_user
обычный («пользователь») -
lk_admin
привилегированный («администратор»)
curl -X PUT \
"https://restapi.plusofon.ru/api/v1/user/aspernatur" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"email":"user@plusofon.ru","phone":"79993332210","first_name":"Ivan","last_name":"Ivanov","middle_name":"Ivanovich","role":"lk_user"}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/user/aspernatur"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"email": "user@plusofon.ru",
"phone": "79993332210",
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"role": "lk_user"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->put(
'https://restapi.plusofon.ru/api/v1/user/aspernatur',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'email' => 'user@plusofon.ru',
'phone' => '79993332210',
'first_name' => 'Ivan',
'last_name' => 'Ivanov',
'middle_name' => 'Ivanovich',
'role' => 'lk_user',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/user/aspernatur'
payload = {
"email": "user@plusofon.ru",
"phone": "79993332210",
"first_name": "Ivan",
"last_name": "Ivanov",
"middle_name": "Ivanovich",
"role": "lk_user"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('PUT', url, headers=headers, json=payload)
response.json()
¶ Структура и примеры ответа
В ответе может возвращаться:
-
success
признак успешно выполненного запроса -
message
сообщение об ошибке
Данные пользователя успешно изменены:
{
"success": true
}
¶ Удаление
DELETE api/v1/user/{user_id}
Метод позволяет удалить конкретного пользователя.
¶ Параметры и примеры запроса
user_idpath
ИД пользователя
curl -X DELETE \
"https://restapi.plusofon.ru/api/v1/user/123" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}"
const url = new URL(
"https://restapi.plusofon.ru/api/v1/user/123"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->delete(
'https://restapi.plusofon.ru/api/v1/user/123',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/user/123'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('DELETE', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе может возвращаться:
-
success
признак успешно выполненного запроса -
message
сообщение об ошибке
Пользователь успешно удалён:
{
"success": true
}
