API стандартизации
Нормализация ФИО и адресов. Адреса проверяются по ФИАС и дополняются координатами.
Стандартизация ФИО
POST /api/v1/clean/nameРазбирает строку с ФИО на компоненты, определяет пол, проверяет по справочникам.
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
query | string | ФИО в произвольном формате |
Пример запроса
curl -X POST https://api.humandata.ru/api/v1/clean/name \-H "Content-Type: application/json" \-H "Authorization: Token YOUR_API_KEY" \-d '{"query": "иванов сергей петрович"}'
Пример ответа
{"source": "иванов сергей петрович","result": {"surname": "Иванов","name": "Сергей","patronymic": "Петрович","gender": "m","qc": 0}}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
surname | string | null | Фамилия |
name | string | null | Имя |
patronymic | string | null | Отчество |
gender | string | null | "m" — мужской, "f" — женский |
qc | number | Код качества: 0 — найдено в справочниках, 1 — неполное ФИО, 2 — не найдено |
Стандартизация адреса
POST /api/v1/clean/addressРазбирает адрес на компоненты, проверяет по ФИАС, возвращает координаты. Один запрос — нормализация и геокодирование сразу.
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
query | string | Адрес в произвольном формате |
Пример запроса
curl -X POST https://api.humandata.ru/api/v1/clean/address \-H "Content-Type: application/json" \-H "Authorization: Token YOUR_API_KEY" \-d '{"query": "москва ленинский 42"}'
Пример ответа
{"source": "москва ленинский 42","result": {"result": "г Москва, пр-кт Ленинский","region": "г Москва","city": null,"street": "пр-кт Ленинский","house": "42","flat": null,"postal_code": null,"fias_id": "5f2a1243-a57b-418e-baee-ff76f4993b45","geo_lat": 55.7034,"geo_lon": 37.5659,"qc_geo": 0,"qc": 0}}
Поля ответа
| Поле | Тип | Описание |
|---|---|---|
result | string | null | Полный нормализованный адрес |
region | string | null | Регион (субъект РФ) |
city | string | null | Город или населённый пункт |
street | string | null | Улица |
house | string | null | Номер дома |
flat | string | null | Квартира |
postal_code | string | null | Почтовый индекс |
fias_id | string | null | Идентификатор в реестре ФИАС (UUID) |
geo_lat | number | null | Широта (WGS-84) |
geo_lon | number | null | Долгота (WGS-84) |
qc_geo | number | null | Точность координат: 0 — дом, 2 — улица, 3 — город, 4 — не определено |
qc | number | Код качества адреса: 0 — найден в ФИАС, 1 — не найден, 2 — неполный, 3 — низкая уверенность |
Коды качества геокодирования (qc_geo)
| Код | Описание |
|---|---|
0 | Координаты дома |
2 | Координаты улицы (дом не найден) |
3 | Координаты города (улица не найдена) |
4 | Координаты не определены |
null | Геокодирование отключено |