Получение информации о реселлере

Метод Get downstream reseller используется для получения информации о текущем реселлере или о его нижестоящем реселлере по уникальному идентификационному номеру.

Для авторизации требуется API-токен менеджера (сотрудника). API-токен можно получить через Панель управления Оператора (см. Просмотр и обновление информации о сотруднике).

По указанному в запросе API-токену определяются:

  • Роль и уровень доступа менеджера, от которых зависит доступность метода.
  • Текущий реселлер и его нижестоящие реселлеры, доступные в рамках метода.

Для получения информации о реселлере или о его нижестоящем реселлере также может использоваться метод Get reseller (Customer Store) (см. Получение информации о реселлере (Customer Store)).

GET {base_url}/api/v3/resellers/{reseller_id}

Аргументы

Название

Тип параметров

Тип данных

Обязательный/Опциональный

Описание

X-Api-TokenheaderstringОбязательныйAPI-токен сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйТип данных, передаваемых в запросе. Необходимо указать: application/vnd.api+json
AcceptheaderstringОбязательныйПоддерживаемые типы данных в ответе. Необходимо указать: application/vnd.api+json
base_urlpathstringОбязательныйURL ActivePlatform

reseller_id

path

integer

Обязательный

ID реселлера. Возможно указать ID текущего реселлера или ID любого из его нижестоящих реселлеров (см. Просмотр информации о реселлере)

Модель ответа

НазваниеТип данныхОписание
idstringУникальный идентификатор реселлера
typestringТип данных
attributesobjectИнформация о реселлере

created_atdateДата создания реселлера

updated_atdateДата обновления информации о реселлере

parent_idstringУникальный идентификатор вышестоящего (родительского) реселлера

generalobjectОбщая информация о реселлере


created_atdateДата создания реселлера


updated_atdateДата обновления информации о реселлере


namestringНазвание реселлера


domainstringДомен реселлера


managerstringИмя сотрудника вышестоящего реселлера (оператора), ответственного за данного реселлера


currencystringКод валюты реселлера ISO 4217 alfa-3

companyobjectМодель информации о компании, которая является данным реселлером


created_atdateДата создания компании


updated_atdateДата обновления информации о компании


citystringГород, в котором расположена компания


zipstringПочтовый индекс компании


countrystringКод страны ISO 3166-1 alpha-2, в которой расположена компания


faxstringНомер факса компании


namestringНазвание компании


address_line_1stringПервая строка адреса компании


address_line_2stringВторая строка адреса компании


statestringШтат/Область, в которой расположена компания


phonestring

Номер телефона компании в международном формате:

  • + < код страны > < код города или сети > < номер телефона >.
  • 00 < код страны > < код города или сети > < номер телефона >.


emailstringАдрес электронной почты компании

contactsobjectМодель информации о контактном лице компании, которая является реселлером


created_atdateДата создания контактного лица


updated_atdateДата обновления информации о контактном лице


first_namestringИмя контактного лица компании


last_amestringФамилия контактного лица компании


middle_namestringОтчество контактного лица компании


positionstringДолжность контактного лица компании


phonestringТелефонный номер контактного лица компании в международном формате:
  • + < код страны > < код города или сети > < номер телефона >.
  • 00 < код страны > < код города или сети > < номер телефона >.


emailstringАдрес электронной почты контактного лица компании

managerobjectИнформация о сотруднике вышестоящего реселлера (оператора), ответственного за данного реселлера


created_atdateДата создания сотрудника


updated_atdateДата последнего обновления информации о сотруднике


reseller_idintegerID вышестоящего реселлера (оператора), к которому относится сотрудник


idintegerID сотрудника


namestringИмя сотрудника


statusstringСтатус сотрудника:
  • active — доступ в Панель управления Оператора разрешен.
  • inactive — доступ в Панель управления Оператора заблокирован


emailstringАдрес электронной почты, который используется в качестве логина сотрудника в Панель управления Оператора


rolestring

Роль сотрудника (см. Роли сотрудников)



phonestringНомер телефона сотрудника в международном формате:
  • + < код страны > < код города или сети > < номер телефона >
  • 00 < код страны > < код города или сети > < номер телефона >


photostringСсылка на файл фотографии сотрудника


manager_keystringУникальный ключ сотрудника


custom_attributesobjectДополнительные параметры сотрудника



['custom_attribute_key']stringЗначение дополнительного параметра сотрудника с указанным ключом

custom_attributesobjectДополнительные параметры реселлера


['custom_attribute_key']stringЗначение дополнительного параметра реселлера с указанным ключом

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

GET /api/v3/resellers/1
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetest3gJXZH5uHCw
Accept: application/vnd.api+json

Пример ответа

{
    "data": {
        "id": "1",
        "type": "resellers",
        "attributes": {
            "created_at": "2016-08-25T09:26:12.491+03:00",
            "updated_at": "2020-01-16T13:10:53.572+03:00",
            "parent_id": 27,
            "general": {
                "created_at": "2016-08-25T09:26:12.491+03:00",
                "updated_at": "2020-01-16T13:10:53.572+03:00",
                "name": "Reseller Root",
                "domain": "test.activeplatform.com",
                "manager": "Alena R",
                "currency": "BYN"
            },
            "company": {
                "created_at": "2016-08-25T09:26:12.491+03:00",
                "updated_at": "2020-01-16T13:10:53.572+03:00",
                "city": "Minsk",
                "zip": "220053",
                "country": "BY",
                "fax": "",
                "name": "Reseller Root",
                "address_line_1": "Main",
                "address_line_2": "str",
                "state": "Минская",
                "phone": "+375250000000",
                "email": "example3@gmail.com"
            },
            "contacts": {
                "created_at": "2016-08-25T09:26:12.491+03:00",
                "updated_at": "2020-01-16T13:10:53.572+03:00",
                "first_name": "Ivan",
                "last_name": "Ivanov",
                "middle_name": "",
                "position": "",
                "phone": "+375260000000",
                "email": "aaaa@example.ru"
            },
            "manager": {
                "created_at": "2017-10-12T15:27:56.354+03:00",
                "updated_at": "2020-11-13T15:49:13.667+03:00",
                "reseller_id": 1,
                "id": 188,
                "name": "Alena R",
                "status": "active",
                "email": "alena@example.com",
                "role": "sales",
                "phone": "+375270000000",
                "photo": "/images/manager/188/188.jpg",
				"manager_key": "",
                "custom_attributes": {}
                },
            "custom_attributes": {
                "inn": "",
                "email": "",
                "l": ""
            }
        }
    }
}