distributors.php¶

В этой статье

Методы API

distributors/add

distributors/delete

distributors/list

distributors/show

distributors/update

API для управления дистрибьюторами, включая создание, удаление, просмотр, обновление и получение списка дистрибьюторов.

Методы API¶

Метод	Действие	Описание
`add`	создание дистрибьютора	Создает нового дистрибьютора на основе переданных параметров.
`delete`	удаление дистрибьютора	Удаляет дистрибьютора по его ID.
`list`	получение списка дистрибьюторов	Возвращает список дистрибьюторов с возможностью фильтрации.
`show`	получение данных дистрибьютора	Возвращает детальную информацию о конкретном дистрибьюторе по его ID.
`update`	обновление дистрибьютора	Обновляет данные существующего дистрибьютора.

distributors/add¶

Создает нового дистрибьютора на основе переданных параметров.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `add`
token	✅	string	Токен авторизации
name	✅	string	Название дистрибьютора
address	❌	string	Адрес дистрибьютора
phone	❌	string	Номер телефона дистрибьютора
email	❌	string	Электронная почта дистрибьютора
location	❌	string	Код страны (в БД: reg_fk_id через locations_id_by_code)
remove	❌	integer	Флаг удаления (0 или 1)
active	❌	integer	Статус активности дистрибьютора (0 или 1)
comment	❌	string	Комментарий к записи

Пример запроса

curl -s "https://invapi.hostkey.ru/distributors.php" -X POST \
--data "action=add" \
--data "token=HOSTKEY_TOKEN" \
--data "name=Example Distributor" \
--data "address=123 Main St" \
--data "phone=+123456789" \
--data "email=info@example.com" \
--data "location=US" \
--data "remove=0" \
--data "active=1" \
--data "comment=New distributor"

Пример успешного ответа

{
"result": "OK",
"module": "distributors",
"action": "add",
"distributor": {
"id": 123,
"name": "Example Distributor",
"address": "123 Main St",
"phone": "+123456789",
"email": "info@example.com",
"remove": 0,
"active": 1,
"comment": "New distributor",
"location": "US",
"reg_fk_id": 1,
"tags": {}
}
}

Примеры ошибок

{
"-1": [
{
"message": "Distributor sup:123 not found"
}
],
"RangeException": [
{
"message": "No action specified"
}
],
"RuntimeException": [
{
"message": "Missing required keys"
}
]
}

distributors/delete¶

Удаляет дистрибьютора по его ID.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `delete`
token	✅	string	Токен авторизации
id	❌	integer	ID дистрибьютора.

Пример запроса

curl -s "https://invapi.hostkey.ru/distributors.php" -X POST \
--data "action=delete" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"module": "distributors",
"action": "delete",
"data": {
"id": 123
}
}

Примеры ошибок

{
"code": -1,
"message": "No action specified"
}

distributors/list¶

Возвращает список дистрибьюторов с возможностью фильтрации.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `list`
token	✅	string	Токен авторизации
location	❌	`array<string>`	Фильтр по коду страны (alpha2). Используется поиск по точному совпадению (word).
name	❌	`array<string>`	Фильтр по части имени для поиска подстроки.
email	❌	`array<string>`	Фильтр по части email для поиска подстроки.
remove	❌	`array<integer>`	Фильтр по флагу удаления. Используется поиск по точному совпадению (word). Допустимые значения: 0, 1.
active	❌	`array<integer>`	Фильтр по статусу активности. Используется поиск по точному совпадению (word). Допустимые значения: 0, 1.

Пример запроса

curl -s "https://invapi.hostkey.ru/distributors.php" -X POST \
--data "action=list" \
--data "token=HOSTKEY_TOKEN" \
--data "location[]=US" \
--data "name[]=Distributor" \
--data "active[]=1"

Пример успешного ответа

{
"result": "OK",
"module": "distributors",
"action": "list",
"distributors": [
{
"id": 1,
"name": "Distributor One",
"address": null,
"phone": null,
"email": "one@test.com",
"remove": 0,
"active": 1,
"comment": null,
"location": "US"
}
]
}

Примеры ошибок

{
"-1": [
{
"message": "No action specified"
},
{
"message": "Action is not recognized"
}
]
}

distributors/show¶

Возвращает детальную информацию о конкретном дистрибьюторе по его ID.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `show`
token	✅	string	Токен авторизации
id	❌	integer	ID дистрибьютора.

Пример запроса

curl -s "https://invapi.hostkey.ru/distributors.php" -X POST \
--data "action=show" \
--data "token=HOSTKEY_TOKEN" \
--data "id=123"

Пример успешного ответа

{
"result": "OK",
"action": "show",
"module": "distributors",
"distributor": {
"id": 123,
"name": "Example Distributor",
"email": "info@example.com",
"location": "US",
"phone": "+123456789",
"address": "123 Main St",
"comment": "New distributor",
"active": true,
"remove": 0,
"tags": {}
}
}

Примеры ошибок

{
"RuntimeException": {
"code": -1,
"message": "Authorization error, token is invalid"
},
"RangeException": {
"code": -1,
"message": "Distributor sup:{id} not found"
}
}

distributors/update¶

Обновляет данные существующего дистрибьютора.

HTTP-метод: POST

Параметры:

Параметр	Обязательный	Тип	Описание
action	✅	string	Идентификатор метода: `update`
token	✅	string	Токен авторизации
id	❌	integer	ID дистрибьютора.
location	✅	string	Код локации. Обязателен для валидации.

Пример запроса

curl -s "https://invapi.hostkey.ru/distributors.php" -X POST \
--data "action=update" \
--data "token=HOSTKEY_TOKEN" \
--data "location=NL"

Пример успешного ответа

{
"result": "OK",
"module": "distributors",
"action": "update",
"distributor": {
"id": 50,
"name": "...",
"address": "...",
"phone": "...",
"email": "...",
"remove": "...",
"active": "...",
"comment": "...",
"location": "NL",
"tags": {}
}
}

Примеры ошибок

{
"-1": [
{
"message": "Action is not recognized"
}
]
}