API ФНС: Прозрачный бизнес

Документация по работе с API ФНС: Прозрачный бизнес

Алгоритм получения результата запроса с помощью нашего сервиса достаточно прост и практически одинаков для всех видов ресурсов.
Получите ваш персональный ключ API в настройках вашего аккаунта.
для каждого пользователя генерируется уникальный аутентификационный токен, мы называем "персональный ключ API". Это строка из 32 символов, которая выглядит примерно так:
53ba1b7a55abbа14aa97eff3a5220792
Этот ключ используется для всех ваших запросов к api-cloud.

История изменений/обновлений API

Предупреждение Установите таймаут (TIMEOUT) ожидания минимум 120 секунд, иначе вы можете не получить результат, ваш код может прерваться не дождавшись ответа

HTTPS GET запрос: https://api-cloud.ru/api/pb_nalog.php
Обязательно использовать HTTPS протокол, иначе запросы будут дублироваться при перенаправлении с HTTP на HTTPS.
Обязательно использовать GET запрос, иначе мы не увидим параметры, которые вы передаете.

type Обязательно	Описание	Параметры в запросе Обязательно
	В одном запросе возможно отправить только 1 тип
search_ip	Поиск по Индивидуальным предпринимателям	Обязательные inn - ИНН ИП Разрешено: цифры (12 символов) token - персональный ключ API
search_org	Поиск по Юридическим организациям	Обязательные inn - ИНН организации Разрешено: цифры (10 символов) token - персональный ключ API

Пример отправки GET запроса на PHP:

function get_rez($url) {
		$ch = curl_init($url);
		curl_setopt($ch, CURLOPT_RETURNTRANSFER,true);
		curl_setopt($ch,CURLOPT_TIMEOUT,120); // Таймаут необходим, поскольку 30 секунд может не хватить и вы не получите ответ 
		$res = curl_exec($ch);
		curl_close($ch);
		return $res;
	}

  $data = [
    'type' => 'Тип запроса (type)',
    ...
    Необходимы для запроса параметры
    ...
    'token' => 'Токен',
    ];

    // Структурированная ссылка для GET запроса
    $url = 'https://api-cloud.ru/api/pb_nalog.php?' . http_build_query($data);

    $data = get_rez($url); // Результат ответа (JSON)

Сервер вернёт результат обработки или код ошибки, если что-то пошло не так.
Сервер возвращает ответ в формате JSON.

Обратите внимание, что скорость загрузки результата зависит напрямую от ресурса источника
При подсчете количества запросов будут приняты к учету только те запросы, которы вернули "status": 200 и "status": 404, т.е. получили результат.

Максимальное количество попыток соединения 3 раза. Если в результате этих попыток ресурс не вернет ответа, то API CLOUD вернет ответ {"status":404, "error":"TIME_MAX_CONNECT", "errormsg":"Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата"}

Примеры запросов

Поиск по Индивидуальным предпринимателям

Пример запроса "Поиск по Индивидуальным предпринимателям" HTTP GET на URL нашего API

https://api-cloud.ru/api/pb_nalog.php?type=search_ip&inn=233410953141&token=53ba1b7a55abbB014aa97eff3a522079

Пример успешного запроса по типу search_ip в формате JSON
Есть данные

{
  "status": 200, // Статус ответа
  "found": true, // Флаг успешности поиска
  "count": 2, // Количество данных
  // Массив с данными
  "data": [
    {
      "ogrn": "322237500371357", // ОГРНИП
      "inn": "233410953141", // ИНН
      "okved": "62.09", // Основной ОКВЭД
      "okved_name": "Деятельность, связанная с использованием вычислительной техники и информационных технологий, прочая", // Расшифровка ОКВЭД
      "name": "КОЧУРА АЛЕКСАНДР ВАСИЛЬЕВИЧ", // ФИО
      "dateReg": "14.10.2022", // Дата регистрации
      "statusIP": 1, // Статус регистрации (1 - действующее ИП / 0 = деятельность прекращена)
      "statusIPDesc": "Действующий ИП", // Расшифровка статуса регистрации
      "edo": "Участник ЭДО" // Если участвует в ЭДО (в результате "Участник ЭДО")
    },
    {
      "ogrn": "316237500033445", // ОГРНИП
      "inn": "233410953141", // ИНН
      "okved": "62.09", // Основной ОКВЭД
      "okved_name": "Деятельность, связанная с использованием вычислительной техники и информационных технологий, прочая", // Расшифровка ОКВЭД
      "name": "КОЧУРА АЛЕКСАНДР ВАСИЛЬЕВИЧ", // ФИО
      "dateReg": "29.06.2016", // Дата регистрации
      "statusIP": 0, // Статус регистрации (1 - действующее ИП / 0 = деятельность прекращена)
      "statusIPDesc": "Деятельность прекращена", // Расшифровка статуса регистрации
      "edo": "" // Если участвует в ЭДО (в результате "Участник ЭДО")
    }
  ],
  "inquiry": {
    "price": 0,
    "balance": 498.79,
    "speed": 1,
    "attempts": 1
  }
}

Поиск по Юридическим организациям

Пример запроса "Поиск по Юридическим организациям" HTTP GET на URL нашего API

https://api-cloud.ru/api/pb_nalog.php?type=search_org&inn=2334109531&token=53ba1b7a55abbB014aa97eff3a522079

Пример успешного запроса по типу search_org в формате JSON
Есть данные

{
  "status": 200, // Статус ответа
  "found": true, // Флаг успешности
  "count": 1, // Количество
  // Массив с результатами 
  "data": [
    {
      "invalid": "0", // Флаг сведения не достоверны (0 - достоверны / 1 - не достоверны)
      "ogrn": "1106234007021", // ОГРН
      "inn": "6234083042", // ИНН
      "okved": "45.20", // Основной ОКВЭД
      "okved_name": "Техническое обслуживание и ремонт автотранспортных средств", // Расшифровка ОКВЭД
      "name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \" АВТОМОЙКА № 1 \"", // Юридическое наименование
      "region": "РЯЗАНСКАЯ ОБЛАСТЬ", // Регион
      "dateReg": "18.08.2010", // Дата регистрации
      "statusORG": 0, // Статус регистрации (1 - действующая организация / 0 = деятельность прекращена)
      "statusORGDesc": "Деятельность прекращена", // Расшифровка статуса регистрации
      "edo": "" // Если участвует в ЭДО (в результате "Участник ЭДО")
    }
  ],
  "inquiry": {
    "price": 0.3,
    "balance": 496.94,
    "speed": 1,
    "attempts": 1
  }
}

История изменений API ФНС: Прозрачный бизнес

дата	что изменилось

Возможные коды ошибок

код (error)	Описание ошибки (message)
888	ИМЯ передаваемой переменной: forbidden symbols present В переменной ИМЯ присутствуют запрещенные символы
766	MISSING_MANDATORY_PARAMETER Отсутствуют обязательные параметры
602	TOKEN_NO_ACCESS Нет доступа к запрашиваему методу запроса
504	TOKEN_LOCKED_IN_THE_SYSTEM Переданный токен заблокирован службой качества / автоматической системой
503	TOKEN_NOT_REGISTERED_IN_THE_SYSTEM Переданный токен не зарегистрирован в системе
502	MISSING_REQUIRED_TOKEN_PARAMETER Отсутствует параметр token
500	MISSING_REQUIRED_TYPE_PARAMETER Отсутствует параметр type
499	WRONG_TOKEN_KEY Вы указали значение параметра token в неверном формате, ключ должен содержать 32 символа.
498	TOKEN_NO_MONEY Для выполнения запроса недостаточно средств, пополните баланс.
460	NO_REQUIRED_PARAMETERS Отсутствуют обязательные параметры
456	MAX_LIMIT Превышено количество одновременных соединений (потоки)
404	TIME_MAX_CONNECT Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата. Повторите попытку позже.
332	inn: parameter not passed Параметр ИНН не передан
331	inn: entered incorrectly ИНН передан некорректно
123	IP_NOT_REGISTERED_IN_THE_SYSTEM Сработала защита IP. Текущий IP не совпадает с заданным в ЛК
111	PARAMETER_CONFLICT Вы указали параметры, которые конфликтуют между собой. Например VIN и regNumber. Необходимо указать либо VIN либо regNumber, что-то одно.
015	DATE_ERROR Ошибка значения переданной даты
005	TEST_TIME_OFF Закончился период тестирования
003	TOKEN_BLOCKED_BY_QUALITY_SERVICE Ваш токен заблокирован службой качества. Свяжитесь с технической поддержкой
002	TOKEN_TEHBLOCK Установлена техническая блокировка токена. Включить или выключить можно самостоятельно в настройках безопасности.
001	API_SUSPENDED Работа этого API временно приостановлена. Мы уже в курсе проблемы и занимаемся решением. Повторите запрос позже.

Пример ответа с ошибкой

{"error":"503","message":"TOKEN_NOT_REGISTERED_IN_THE_SYSTEM"}