↑ Все API
Код проверки
API: стандартизация ФИО
✔️ Исправляет опечатки и транслитерирует.
✔️ Проставляет пол.
✔️ Склоняет по падежам (кого? кому? кем?).
Как вызвать
Чтобы вызвать метод, и подтвердите почту.
Пример запроса:
POST https://cleaner.dadata.ru/api/v1/clean/name[ "Срегей владимерович иванов" ]
Укажите при вызове:
Content-Type: application/json
.Accept: application/json
.${API_KEY}
— API-ключ.${SECRET_KEY}
— секретный ключ.
Тело запроса передавайте в кодировке UTF-8
.
Что в ответе
Стандартизованный объект:
[ { "source": "Срегей владимерович иванов", "result": "Иванов Сергей Владимирович", "result_genitive": "Иванова Сергея Владимировича", "result_dative": "Иванову Сергею Владимировичу", "result_ablative": "Ивановым Сергеем Владимировичем", "surname": "Иванов", "name": "Сергей", "patronymic": "Владимирович", "gender": "М", "qc": 1 } ]
Название | Тип | Описание |
---|---|---|
source | string(100) | Исходное ФИО одной строкой |
result | string(150) | Стандартизованное ФИО одной строкой |
result_genitive | string(150) | ФИО в родительном падеже (кого?) |
result_dative | string(150) | ФИО в дательном падеже (кому?) |
result_ablative | string(150) | ФИО в творительном падеже (кем?) |
surname | string(50) | Фамилия |
name | string(50) | Имя |
patronymic | string(50) | Отчество |
gender | string(10) | ПолМ — мужской Ж — женский НД — не удалось однозначно определить |
qc | number | Код проверки |
Код проверки qc
Требуется ли вручную проверить распознанное значение:
Код qc | Описание | Нужно проверить вручную? |
---|---|---|
0 | Исходное значение распознано уверенно | нет |
2 | Исходное значение пустое или заведомо «мусорное» | нет |
1 | Исходное значение распознано с допущениями или не распознано | да |
Коды ответа на запрос
HTTP-код ответа | Описание |
---|---|
200 | Запрос успешно обработан |
400 | Некорректный запрос |
401 | В запросе отсутствует API-ключ или секретный ключ Или в запросе указан несуществующий ключ |
403 | Не подтверждена почта Или недостаточно средств для обработки запроса, пополните баланс |
405 | Запрос сделан с методом, отличным от POST |
429 | Слишком много запросов в секунду или новых соединений в минуту |
5xx | Произошла внутренняя ошибка сервиса |
Примеры и интеграции
- C# / .NET
- Excel VBA
- Go
- Java (Spring)
- Laravel
- Node.js
- PHP
- PHP (одним файлом)
- Python
- R
- Symfony
- Ruby
- Битрикс
- Битрикс24: роботы
Ограничения
В запросе разрешено передавать только одно ФИО.
Максимальная частота запросов — 20 в секунду с одного IP-адреса.
Максимальная частота создания новых соединений — 60 в минуту с одного IP-адреса.
Дадата не поддерживает вызов этого метода из браузерного JavaScript. Иначе злоумышленник мог бы похитить секретный ключ и использовать API за ваш счет.