Публичный REST API

Документация FIO API

REST API для поиска фамилий, имен и отчеств

https://d.codis.online/api

Быстрый старт

Начните работу с API за 3 простых шага

Выберите эндпоинт

Выберите подходящий API эндпоинт для поиска

Настройте параметры

Добавьте поисковую строку и параметры

Отправьте запрос

Используйте HTTP GET для получения результатов

API Методы

Доступные эндпоинты для поиска ФИО

Поиск по фамилии

GET

Поиск записей по фамилии (минимум 2 символа)

Параметры

qstringПоисковая строка для фамилии

limitnumberКоличество результатов (по умолчанию 50, максимум 100)

offsetnumberСмещение для пагинации (по умолчанию 0)

Пример

/api/surname?q=Иванов&limit=5

Поиск по имени

GET

Поиск записей по имени (минимум 2 символа)

Параметры

qstringПоисковая строка для имени

limitnumberКоличество результатов (по умолчанию 50, максимум 100)

offsetnumberСмещение для пагинации (по умолчанию 0)

Пример

/api/name?q=Иван&limit=5

Поиск по отчеству

GET

Поиск записей по отчеству (минимум 2 символа)

Параметры

qstringПоисковая строка для отчества

limitnumberКоличество результатов (по умолчанию 50, максимум 100)

offsetnumberСмещение для пагинации (по умолчанию 0)

Пример

/api/patronymic?q=Иванович&limit=5

Поиск по полному ФИО

GET

Универсальный поиск по ФИО. Одно слово - поиск по фамилии, два слова - поиск по фамилии и имени, три слова - поиск по фамилии, имени и отчеству

Параметры

qstringПоисковая строка (одно слово для фамилии, "Фамилия Имя" или "Фамилия Имя Отчество")

limitnumberКоличество результатов (по умолчанию 50, максимум 100)

offsetnumberСмещение для пагинации (по умолчанию 0)

Пример

/api/full-name?q=Иванов Иван Иванович&limit=5

Поиск по фамилии и имени

GET

Поиск записей по фамилии и имени. Одно слово - поиск по фамилии, два слова - поиск по фамилии и имени

Параметры

qstringПоисковая строка (одно слово для фамилии или "Фамилия Имя")

limitnumberКоличество результатов (по умолчанию 50, максимум 100)

offsetnumberСмещение для пагинации (по умолчанию 0)

Пример

/api/surname-name?q=Петров Петр&limit=5

Поиск по имени и отчеству

GET

Поиск записей по имени и отчеству (минимум 2 символа для каждого поля)

Параметры

qstringПоисковая строка для имени

patronymicstringОтчество для поиска

limitnumberКоличество результатов (по умолчанию 50, максимум 100)

offsetnumberСмещение для пагинации (по умолчанию 0)

Пример

/api/name-patronymic?q=Иван Петрович&limit=5

Типы данных

FIO Record

Структура записи ФИО

{
  "id": "string",
  "surname": "string",
  "name": "string", 
  "patronymic": "string",
  "created_at": "string"
}

API Response

Структура ответа API

{
  "data": [FIO Record],
  "total": "number",
  "limit": "number",
  "offset": "number"
}

Обработка ошибок

Неверные параметры

{
  "error": "Неверные параметры запроса",
  "message": "Параметр 'q' обязателен"
}

Слишком короткий запрос

{
  "error": "Слишком короткий поисковый запрос",
  "message": "Минимум 2 символа"
}

Примеры использования

Полный рабочий процесс

1. Получить записи

curl -X GET "https://d.codis.online/api/surname?q=Иванов&limit=10"

2. Поиск по полному ФИО

curl -X GET "https://d.codis.online/api/full-name?q=Петров Петр Петрович&limit=5"