¶ Plusofon API — акции
версия от 2023-02-13
Группа методов позволяет получать информацию по акциям и активировать промокоды.
Адрес: https://restapi.plusofon.ru
¶ Получение списка
GET api/v1/promotions
Метод позволяет получить список активированных акций.
¶ Параметры и примеры запроса
Не имеет параметров.
curl -X GET \
-G "https://restapi.plusofon.ru/api/v1/promotions" \
-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/promotions"
);
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/promotions',
[
'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/promotions'
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('GET', url, headers=headers)
response.json()
¶ Структура и примеры ответа
В ответе возвращается массив data:
-
idstring
ИД акции -
namestring
название акции -
infostring
описании акции -
activated_atstring
дата активации -
end_datestring
дата окончания акции -
statusobject
объект со статусом акции-
/
namestring
код статуса -
/
titlestring
название статуса
-
-
descriptionstring
комментарий
Получен список акций:
{
"current_page": 1,
"data": [
{
"id": "1a801bac-e859-350b-c17a-62d96d70ba11",
"name": "NUMBER10",
"info": "Промо-код позволяет приобрести один телефонный номер за 1 рубль.",
"activated_at": "2022-07-21 15:14:39",
"end_date": null,
"status": {
"name": "Closed Won",
"title": "Акция применена"
},
"description": " номер за 1 рубль"
}
],
"first_page_url": "http:\/\/localhost\/api\/v1\/promotions?page=1",
"from": 1,
"next_page_url": null,
"path": "http:\/\/localhost\/api\/v1\/promotions",
"per_page": 15,
"prev_page_url": null,
"to": 1
}
Пользователь не найден:
{
"message": "User not found.",
"code": 500
}
¶ Активация
POST api/v1/promotions
Метод позволяет применить промокод для активации акции.
¶ Параметры и примеры запроса
Body
promo_codestring
⁎ имя акции (промокод)
curl -X POST \
"https://restapi.plusofon.ru/api/v1/promotions" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Client: 10553" \
-H "Authorization: Bearer {token}" \
-d '{"promo_code":"hic"}'
const url = new URL(
"https://restapi.plusofon.ru/api/v1/promotions"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
"Client": "10553",
"Authorization": "Bearer {token}",
};
let body = {
"promo_code": "hic"
}
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/promotions',
[
'headers' => [
'Content-Type' => 'application/json',
'Accept' => 'application/json',
'Client' => '10553',
'Authorization' => 'Bearer {token}',
],
'json' => [
'promo_code' => 'hic',
],
]
);
$body = $response->getBody();
print_r(json_decode((string) $body));
import requests
import json
url = 'https://restapi.plusofon.ru/api/v1/promotions'
payload = {
"promo_code": "hic"
}
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Client': '10553',
'Authorization': 'Bearer {token}'
}
response = requests.request('POST', url, headers=headers, json=payload)
response.json()
¶ Структура и примеры ответа
В ответе может возвращаться:
-
success
признак успешно выполненного запроса -
message
сообщение об ошибке
Акция успешно активирована:
{
"success": true
}
Пользователь не найден:
{
"message": "User not found.",
"code": 500
}
