¶ Plusofon API — управление абонентом
версия от 2023-02-13
Группа методов позволяет получать общие данные текущего абонента и менять статус двухфакторной аутентификации.
Адрес: https://restapi.plusofon.ru
¶ Получение данных
GET api/v1/customer-info
Метод позволяет получить общие данные текущего абонента.
¶ Параметры и примеры запроса
Не имеет параметров.
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/customer-info" \
-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/customer-info"
);
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/customer-info',
[
'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/customer-info'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается:
-
id
ИД абонента -
tariff
объект с текущим тарифом-
/
name
название тарифа -
/
description
описание тарифа
-
-
expiration_date
объект со сроком тестового периода-
/
days
количество дней до окончания -
/
expiration
дата и время окончания
-
-
block
объект с существующими блокировками- /
type
тип блокировки
- /
-
unread_sms
количество непрочитанных SMS
Данные абонента:
{
"id": 1234,
"tariff": {
"name": "Тестовый",
"description": "Облачная АТС"
},
"expiration_date": {
"days": 14,
"expiration": "2022-12-31 14:57:40"
},
"block": {
"type": "agreement"
},
"unread_sms": 0,
"finally_created": true,
"success": true
}
¶ 2FA: получение статуса
GET api/v1/customer/tfa
Метод позволяет получить текущий статус режима двухфакторной аутентификации.
¶ Параметры и примеры запроса
Не имеет параметров.
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/customer/tfa" \
-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/customer/tfa"
);
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/customer/tfa',
[
'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/customer/tfa'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе может возвращаться:
-
tfa_activeboolean
признак включенного режима двухфакторной аутентификации -
success
признак успешно выполненного запроса -
message
сообщение об ошибке
Получен текущий статус:
{
"tfa_active": true,
"success": true
}
¶ 2FA: включение
PUT api/v1/customer/tfa
Метод позволяет включить двухфакторную аутентификацию.
¶ Параметры и примеры запроса
Body
pinstring
⁎ пин-кодi
curl -X PUT \
"https://restapi.plusofon.ru/api/v1/customer/tfa" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"pin":"1234"}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/customer/tfa"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"pin": "1234"
}
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/customer/tfa',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'pin' => '1234',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/customer/tfa'
payload = {
"pin": "1234"
}
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
}
¶ 2FA: выключение
DELETE api/v1/customer/tfa
Метод позволяет отключить двухфакторную аутентификацию.
¶ Параметры и примеры запроса
Body
pinstring
⁎ пин-кодi
curl -X DELETE \
"https://restapi.plusofon.ru/api/v1/customer/tfa" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"pin":"1234"}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/customer/tfa"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"pin": "1234"
}
fetch(url, {
method: "DELETE",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
$client = new \GuzzleHttp\Client();
$response = $client->delete(
'https://restapi.plusofon.ru/api/v1/customer/tfa',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'pin' => '1234',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/customer/tfa'
payload = {
"pin": "1234"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('DELETE', url, headers=headers, json=payload)
response.json()
¶ Структура и примеры ответа
В ответе может возвращаться:
-
success
признак успешно выполненного запроса -
message
сообщение об ошибке
Двухфакторная аутентификация отключена:
{
"success": true
}
