Получение списка нижестоящих Реселлеров

Для получения cписка нижестоящих Реселлеров используется два метода:

  • Get the downline resellers list
    GET {base_url}/api/v3/resellers/{reseller_id}/child_resellers

  • Get Resellers List 
    GET {base_url}/customer_store/resellers/

Метод Get the downline resellers list позволяет получить cписок нижеcтоящих Реселлеров вне зависимости от наличия модуля Customer Store. Метод Get Resellers List доступен только при наличии установленного модуля Customer Store (см. Модуль "Настройки Customer Store").

Get the downline resellers list

Метод Get the downline resellers list используется для получения списка нижестоящих Реселлеров по отношению к текущему Реселлеру, или по отношению к его выбранному нижестоящему Реселлеру.

Доступ к текущему Реселлеру, относительно которого формируется список нижестоящих Реселлеров, определяется по токену Сотрудника, указанному в заголовке запроса.

Список Реселлеров может быть показан в рамках конкретной страницы. Для этого необходимо передать следующие аргументы:

  • номер страницы (page);
  • количество элементов на странице (per_page).
GET {base_url}/api/v3/resellers/{reseller_id}/child_resellers

Аргументы

Название

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

Тип данных

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

Описание

X-Api-TokenheaderstringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)
Content-TypeheaderstringОбязательныйПредназначен для информирования сервера о типах данных, которые поддерживаются клиентом (браузером)
AcceptheaderstringОбязательныйПредназначен для идентификации формата и способа представления сущности
reseller_idpathintegerОбязательныйID Реселлера. Возможно указать ID текущего Реселлера или ID любого из его нижестоящих Реселлеров (см. Просмотр информации о реселлере)

page

query

integer

Опциональный

Возвращается список Реселлеров по указанному номеру страницы

per_page

query

integer

Опциональный

Установка числа элементов на странице

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

Аналогично Get Resellers List

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

GET http://reseller.activeplatform.com/api/v3/resellers/302/child_resellers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
X-Api-Token:qQwW12

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

Аналогично Get Resellers List

Get Resellers List

Метод Get Resellers List используется для получения списка нижестоящих Реселлеров по отношению к текущему Реселлеру.

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

Список Реселлеров может быть показан в рамках конкретной страницы. Для этого необходимо передать следующие аргументы:

  • номер страницы (page);
  • количество элементов на странице (per_page).
GET {base_url}/customer_store/resellers/

Аргументы

Название

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

Тип данных

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

Описание

api_tokenquerystringОбязательныйAPI токен Сотрудника, выполняющего операцию (см. Просмотр и обновление информации о сотруднике)

page

query

integer

Опциональный

Возвращается список Реселлеров по указанному номеру страницы

per_page

query

integer

Опциональный

Установка числа элементов на странице

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

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

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

created-atdateДата создания Реселлера

updated-atdateДата обновления информации о Реселлере

generalobjectМодель основной информации о Реселлере


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


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


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


managerstringМенеджер, прикрепленный к Реселлеру

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


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


address-line-1stringПервая строка адреса компании


address-line-2stringВторая строка адреса компании


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


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


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


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


phonestring

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

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


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


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

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


first-namestringИмя контактного лица компании


last-namestringФамилия контактного лица компании


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


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


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


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

attributes.custom-attributesobjectДополнительные параметры Реселлера


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/

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

{
    "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"
                }
            }
        },
        {
        "id": "2",
            "type": "resellers",
            "attributes": {
                "created-at": "2017-06-12T17:41:51.694+03:00",
                "updated-at": "2017-12-24T10:38:53.600+03:00",
                "parent-id": 1,
                "general": {
                    "name": "Company 2",
                    "domain": "cn2.billing.activeplatform.com",
                    "manager": "Manager 2",
                    "currency": "USD"
                },
                "company": {
                    "name": "Company name 2",
                    "address-line-1": "Nezalezhnosty av., 2",
                    "address-line-2": "Sovietsky distr.",
                    "city": "Minsk",
                    "state": "Minskaya",
                    "zip": "220000",
                    "country": "BY",
                    "fax": "+375172545458",
                    "phone": "+375292968624",
                    "email": "company2@example.com"
                },
                "contacts": {
                    "first-name": "Petr",
                    "last-name": "Ivanov",
                    "middle-name": "Ivanovich",
                    "position": "Sales representative",
                    "phone": "+375290478626",
                    "email": "ivanov.company2@example.com"
                },
                "custom-attributes": {
                    "1c password ": "password",
                    "1c api name ": "1c api",
                    "kpp": "444342617931",
                    "inn": "55411113276",
                    "reseller pin": "4321"
                }
            }
        }
    ],
    "links": {
        "self": "http://billing.activeplatform.com/api/v3/customer_store/resellers?page%5Bnumber%5D=1&page%5Bsize%5D=50",
        "next": "http://billing.activeplatform.com/api/v3/customer_store/resellers?page%5Bnumber%5D=2&page%5Bsize%5D=50",
        "last": "http://billing.activeplatform.com/api/v3/customer_store/resellers?page%5Bnumber%5D=5&page%5Bsize%5D=50"
    }
}