Простой API для получения данных по идентификатору организации. Запросы и ответы — в формате JSON. Доступ — по личному API-ключу.
API готовится к запуску. Ниже описан контракт текущего проекта. Публичный адрес станет доступен после подключения сервера.
Авторизация
Передавайте ключ в заголовке X-API-Key. Получить ключ через сайт нельзя. В примерах используется переменная окружения, а не настоящий ключ.
Поиск
POST /lookup
Передайте один идентификатор: inn — ИНН или ogrn — ОГРН. Значение должно быть строкой.
Пример запроса
Пример для терминала Bash. Планируемый адрес: https://dadata.space/api/lookup.
curl https://dadata.space/api/lookup \
-H "Content-Type: application/json" \
-H "X-API-Key: $DATASPACE_API_KEY" \
-d '{"inn":"7707083893"}'
Для поиска по ОГРН замените тело запроса:
{"ogrn":"1027700132195"}
Формат ответа
Иллюстрация структуры, не результат реального запроса. Отсутствующие сведения возвращаются как null.
{
"ogrn": "1027700132195",
"inn": "7707083893",
"phone": null,
"email": null,
"from_cache": false
}
| Поле | Описание |
|---|
ogrn | ОГРН, строка или null |
inn | ИНН, строка или null |
phone | Опубликованный деловой телефон, строка или null |
email | Опубликованная деловая почта, строка или null |
from_cache | true — сохранённый результат; false — новый запрос |
Коды ответа
| Код | Значение |
|---|
| 200 | Запрос выполнен |
| 400 | Не указан ИНН или ОГРН |
| 403 | Ключ отсутствует или неверен |
| 422 | Некорректный формат запроса |
| 500 | Внутренняя ошибка сервиса |
| 504 | Истекло время ожидания источника данных |
Ошибки текущего API возвращаются в поле detail. Скорость ответа зависит от источника данных и наличия результата в кэше.