Поиск организации в сервисе автозаполнения

Метод используется для поиска организации в сервисе автозаполнения по указанному значению атрибута при создании аккаунта (см. Создание аккаунта). Метод возвращает одностраничный список подходящих организаций и информацию о них.

POST {reseller_domain}/internal_api/autofill_organization/search

В этой статье:

Авторизация

Требуется авторизация с помощью access token пользователя.

Аргументы

Название		Тип параметра	Тип данных	Обязательный/ Опциональный	Описание
Content-Type		header	string	Обязательный	Тип данных, передаваемых в запросе. Укажите application/vnd.api+json
Accept		header	string	Обязательный	Поддерживаемые типы данных в ответе. Укажите application/vnd.api+json
X-Api-Locale		header	string	Опциональный	Двухбуквенный код языка данных в ответе
Authorization		header	string	Обязательный	Действующий access token пользователя. Формат: `Bearer <access token>`
reseller_domain		path	string	Обязательный	Доменное имя реселлера
query		form	object	Обязательный	Критерий поиска организаций
	field_name	form	string	Обязательный	Ключ атрибута, для которого доступен сервис автозаполнения (см. `autofill_organization` в Получение списка атрибутов для создания аккаунта )
	field_value	form	string	Обязательный	Значение атрибута

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

Название		Тип данных	Описание
data		array of objects	Данные ответа
	id	string	ID результата поиска
	attributes	object	Информация о найденной организации в виде пар ключ-значение

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

Bash

curl --location --request POST 'https://test.activeplatform.com/internal_api/autofill_organization/search' \
--header 'Content-Type: application/vnd.api+json' \
--header 'Accept: application/vnd.api+json' \
--header 'X-Api-Locale: en' \
--header 'Authorization: Bearer AccessTokenExample' \
--data '{
    "data": {
        "attributes": {
            "query": {
                "field_name": "primary_name",
                "field_value": "Cond"
            }
        }
    }
}'

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

JSON

{
    "data": [
        {
            "id": "1",
            "attributes": {
                "primary_name": "Condax",
                "kpp": "970401001",
                "inn": "9712040126",
                "ogrn": "9027700092661",
                "zip": "100200",
                "country": "UU",
                "region": "Olson",
                "city": "Olson",
                "street": "Greenfield",
                "building": "1",
                "office": null,
                "address_line_1": "100200, Olson, Greenfield, 1"
            }
        },
        {
            "id": "2",
            "attributes": {
                "primary_name": "Condtech",
                "kpp": "924501001",
                "inn": "9274108180",
                "ogrn": "9060274000192",
                "zip": "200100",
                "country": "UU",
                "region": "Discover",
                "city": "Discover",
                "street": "Springs",
                "building": "131",
                "office": null,
                "address_line_1": "200100, Discover, Springs, 131"
            }
        }
    ]
}