Синтаксис запроса
Чтобы обратиться к методу API ЗАЧЕСТНЫЙБИЗНЕС, следует выполнить POST или GET запрос следующего вида:
https://zachestnyibiznesapi.ru/VERSION_NAME/data/METHOD_NAME?PARAMETERS&api_key=YOUR_API_KEY&_format=FORMAT_NAME
Состав запроса:
| наименование | описание | требование | метод |
|---|---|---|---|
| VERSION_NAME | версия API, к которому идет обращение. Описание находится в разделе "Описание версии" | обязательно | GET / POST |
| METHOD_NAME | название метода API, к которому идет обращение. Полный список методов доступен в данной документации. | обязательно | GET / POST |
| PARAMETERS | входные параметры соответствующего метода API, последовательность пар name=value, разделенных амперсандом (&). Список параметров указан на странице с описанием метода. | опционально | GET / POST |
| YOUR_API_KEY | API ключ доступа, комбинация цифр и букв (например: 7bf5dMDIJ30f2yXvKsYhSm95Y0LjTHIu). API ключ вы можете увидеть на странице приложения, нажав на кнопку "статистика" в разделе Мои приложения. | опционально | GET / POST |
| FORMAT_NAME | формат ответа. По умолчанию используется JSON. Вы можете запросить ответ в форматах JSON или XML, указав GET параметр _format=json или _format=xml соответственно. Обращаем Ваше внимание на то, что не все методы могут корректно отвечать в формате XML. Для стабильной работы рекомендуется использовать ответ в формате JSON | опционально | GET |
Формат ответа
Ответ API ЗАЧЕСТНЫЙБИЗНЕС имеет формат:
{
"status":"STATUS_IDENTITY",
"message":"MESSAGE",
"body":"DATA"
}
Состав ответа:
| наименование | описание | наличие |
|---|---|---|
| STATUS_IDENTITY | Идентификатор статуса ответа. Список статусов представлен здесь. | всегда |
| MESSAGE | Описание ответа. Список описаний ответа представлен здесь. | всегда |
| DATA | Полезные данные. Модели данных находятся под описанием соответствующего метода. | в случае успешного ответа |
Статусы ответа:
Статусы ответа представлены в методе answer-code-status-list
Метод answer-code-status-list
Получение списка статусов ответа.
Сигнатура:
METHOD_NAME = answer-code-status-list
Является общим для всех версий API.
URL метода answer-code-status-list имеет вид:
https://zachestnyibiznesapi.ru/VERSION/data/answer-code-status-list
Пример:
Запрос:
https://zachestnyibiznesapi.ru/paid/data/answer-code-status-list
Ответ:
JSON (и только json)
{
"status": "200",
"message": "Запрос выполнен успешно",
"body": {
"200": "Запрос выполнен успешно",
"201": "Отсутствует параметр - ключ API (api_key)",
"202": "Отсутствует параметр - ID (id)",
"203": "Отсутствует параметр - строка запроса (string)",
"204": "Отсутствует параметр - формат вывода ответа (_format)",
"205": "Отсутствует параметр - тариф API (tariff)",
"206": "Отсутствует параметр - размер страницы ответа (page)",
"207": "Отсутствует параметр - IDS (ids)",
"211": "Ваш ключ не активен.",
"212": "Истек лимит запросов по вашему тарифному плану.",
"213": "Истек срок действия вашего тарифного плана.",
"214": "Задан неверный id компании.",
"215": "Задан неверный ключ API.",
"216": "Введен неверный ОГРН/ИНН.",
"217": "Введен неверный формат(_format).",
"218": "ОГРН принадлежит Индивидуальному Предпринимателю. Финансовая отчетность доступна только по Юридическим Лицам.",
"219": "По данному ОГРН не найдено финансовой отчетности.",
"220": "По данному ИНН не найдено судебных дел.",
"221": "По данному ИНН не найдено судебных дел.",
"222": "По данному id не найдено судебного дела.",
"223": "По данному ИНН не найдено информации.",
"224": "По данному ОГРН не найдено информации.",
"225": "Данная страница не существует.",
"226": "Опция недоступна.",
"227": "Доступны только POST запросы.",
"228": "Список идентификаторов не должен быть массивом.",
"229": "Уменьшите количество отслеживаемых документов.",
"230": "Превышен лимит отслеживаний.",
"231": "Запрос на новый тариф отправлен.",
"232": "Подписки отсутствуют.",
"233": "Изменения за запрошенную дату отсутствуют."
}
}
Метод api-key
Получение сведений о ключе API.
Сигнатура:
METHOD_NAME = api-key
Является общим для всех версий API.
URL метода answer-code-status-list имеет вид:
https://zachestnyibiznesapi.ru/VERSION/data/api-key?YOUR_API_KEY
Пример:
Запрос:
https://zachestnyibiznesapi.ru/paid/data/api-key?YOUR_API_KEY
Ответ:
JSON (и только json)
{
"status": "200",
"message": "Запрос выполнен успешно",
"body": {
"tariff": "Мониторинг 1000",
"create_date": "2018-02-01 17:43:53",
"update_date": "2018-06-29 18:59:01"
}
}