Получение информации о Реселлере
Для получения информации о Реселлере или о его нижестоящем Реселлере используется два метода:
- Get downline Reseller information by ID
GET {base_url}/api/v3/resellers/{reseller_id}
- Get Reseller by ID
GET {base_url}/customer_store/resellers/{reseller_id}
Оба метода возвращают один и тот же ответ.
Метод Get downline Reseller information by ID работает вне зависимости от наличия модуля Customer Store. Метод Get Resellers List доступен только при наличии установленного модуля Customer Store (см. Модуль "Настройки Customer Store").
Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.
Get downline Reseller information by ID
Метод Get downline Reseller information by ID позволяет получить информацию о текущем Реселлере или о его нижестоящем Реселлере по уникальному идентификационному номеру.
GET {base_url}/api/v3/resellers/{reseller_id}
Аргументы
Название | Тип параметров | Тип данных | Обязательный/Опциональный | Описание |
---|---|---|---|---|
X-Api-Token | header | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) |
Content-Type | header | string | Обязательный | Предназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером) |
Accept | header | string | Обязательный | Предназначен для идентификации формата и способа представления сущности |
reseller_id | path | integer | Обязательный | ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере) |
Модель ответа
Аналогично Get Reseller by ID
Пример запроса
GET http://reseller.activeplatform.com/api/v3/resellers/1
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
X-Api-Token:qQwW12
Пример ответа
Аналогично Get Reseller by ID
Get Reseller by ID
Метод Get Reseller by ID позволяет получить информацию о текущем Реселлере или о его нижестоящем Реселлере по уникальному идентификационному номеру.
GET {base_url}/customer_store/resellers/{reseller_id}
Аргументы
Название | Тип параметров | Тип данных | Обязательный/Опциональный | Описание |
---|---|---|---|---|
api-token | query | string | Обязательный | API токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике) |
reseller_id | path | integer | Обязательный | ID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере) |
Модель ответа
Название | Тип данных | Описание | ||
---|---|---|---|---|
id | string | Уникальный идентификатор Реселлера | ||
type | string | Тип данных | ||
attributes | object | Информация о Реселлере | ||
parent-id | string | Уникальный идентификатор вышестоящего (родительского) Реселлера | ||
created-at | date | Дата создания Реселлера | ||
updated-at | date | Дата обновления информации о Реселлере | ||
general | object | Общая информация о Реселлере | ||
name | string | Название Реселлера | ||
domain | string | Домен Реселлера | ||
currency | string | Код валюты Реселлера ISO 4217 alfa-3. | ||
manager | string | Менеджер, прикрепленный к Реселлеру | ||
company | object | Модель информации о компании, которая является данным Реселлером | ||
name | string | Название компании | ||
address-line-1 | string | Первая строка адреса компании | ||
address-line-2 | string | Вторая строка адреса компании | ||
city | string | Город, в котором расположена компания | ||
state | string | Штат/Область, в которой расположена компания | ||
zip | string | Почтовый индекс компании | ||
country | string | Код страны ISO 3166-1 alpha-2, в которой расположена компания | ||
phone | string | Номер телефона компании в международном формате:
| ||
fax | string | Номер факса компании | ||
string | Адрес электронной почты компании | |||
contacts | object | Модель информации о контактном лице компании, которая является Реселлером | ||
first-name | string | Имя контактного лица компании | ||
last-name | string | Фамилия контактного лица компании | ||
middle-name | string | Отчество контактного лица компании | ||
position | string | Должность контактного лица компании | ||
phone | string | Телефонный номер контактного лица компании в международном формате:
| ||
string | Адрес электронной почты контактного лица компании | |||
attributes.custom-attributes | object | Дополнительные параметры Реселлера | ||
attributes.custom-attributes['custom-attribute-key'] | string | Значение Дополнительного параметра |
Пример запроса
curl -X GET -H "Content-Type: application/vnd.api+json" -H "Accept: application/vnd.api+json" -H "X-Api-Token: G2dYuBK44dgYu90id1122e" http://billing.activeplatform.com/api/v3/customer_store/resellers/1
Пример ответа
{
"data": {
"id": "1",
"type": "resellers",
"attributes": {
"created-at": "2017-06-09T15:44:51.694+03:00",
"updated-at": "2017-12-22T16:38:53.600+03:00",
"parent-id": 1,
"general": {
"name": "Company 1",
"domain": "cn1.billing.activeplatform.com",
"manager": "Manager 1",
"currency": "USD"
},
"company": {
"name": "Company name 1",
"address-line-1": "Nezalezhnosty av., 1",
"address-line-2": "Sovietsky distr.",
"city": "Minsk",
"state": "Minskaya",
"zip": "220000",
"country": "BY",
"fax": "+375170345678",
"phone": "+375290468624",
"email": "company@example.com"
},
"contacts": {
"first-name": "Ivan",
"last-name": "Petrov",
"middle-name": "Ivanovich",
"position": "Sales representative",
"phone": "+375290468624",
"email": "petrov.company@example.com"
},
"custom-attributes": {
"1c password ": "password",
"1c api name ": "1c api",
"kpp": "234342617111",
"inn": "23411113234",
"reseller pin": "1234"
}
}
}
}