API ras.arbitr (Банк решений)

Документация по работе с API ras.arbitr (Решения арбитражных судов)

Алгоритм получения результата запроса с помощью нашего сервиса достаточно прост и практически одинаков для всех видов ресурсов.
Получите ваш персональный ключ API в настройках вашего аккаунта.
для каждого пользователя генерируется уникальный аутентификационный токен, мы называем "персональный ключ API". Это строка из 32 символов, которая выглядит примерно так:
53ba1b7a55abbа14aa97eff3a5220792
Этот ключ используется для всех ваших запросов к api-cloud.
Отправьте запрос HTTP GET на URL нашего API: https://api-cloud.ru/api/ras_arbitr.php с персональным ключом 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/ras_arbitr.php?' . http_build_query($data);

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

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

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

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

type (Метод)	Описание	Параметры в запросе
	В одном запросе возможно отправить только 1 тип
search	Поиск по базе ras.arbitr • ID дела • Ссылка на дело на kad.arbitr.ru • Дата регистрации документа • Номер инстанции • Название файла • Ссылка для загрузки файла • Уровень инстанции • Название суда • Тип документа • Уточнения по типу документа	Обязательные token - персональный ключ API Дополнительные (можно указать хоть один, хоть несколько) text - Текст поиска по документу (так же можно указывать VIN и гос номера автомобилей) Разрешено: латиница, кирилица, цифры disputeTypes - Вид спора (Значения) Разрешено: цифры, соответствие маске courts - Суд (Значения) Разрешено: латиница, соответствие маске CaseNumber - Номер дела Разрешено: кирилица, цифры, знаки "- /" participant - Участник дела, ИНН, ФИО участника или название организации Разрешено: латиница, кирилица, цифры, знаки "-" startDate - Дата начала поиска Разрешено: формат (дд.мм.гггг) finishDate - Дата окончания поиска Разрешено: формат (дд.мм.гггг) page - номер страницы поиска (по умолчанию: 1) Разрешено: цифры

Важная информация:

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

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

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

Пример запроса "search" HTTP GET на URL нашего API

https://api-cloud.ru/api/ras_arbitr.php?type=search&text=Текст поиска по документу&token=53ba1b7a55abbB014aa97*****22079

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

{
  "status": 200, // Статус ответа
  "PagesCount": 40, // Всего страниц
  "TotalCount": 272784, // Всего записей
  "NumOnPage": 25, // Количество записей на странице
  "Page": 1, // Номер текущей страницы поиска
  // Массив с результатами
  "Result": [
    {
      "CaseId": "85874111-fc66-46fd-a69f-2fa2c27c5655", // CaseId дела (для API kad.arbitr)
      "CaseUrl": "https://kad.arbitr.ru/Card/85874111-fc66-46fd-a69f-2fa2c27c5655", // Ссылка на дело на kad.arbitr.ru
      "RegistrationDate": "17.02.2024", // Дата регистрации документа
      "InstanceNumber": "А50-22591/2022", // Номер инстанции
      "CaseNumber": "А50-22000-2022__20240217", // Номер дела
      "FileName": "А50-22000-2022__20240217.pdf", // Название файла
      "FileUrl": "https://ras.arbitr.ru/Document/Pdf/85874111-fc66-46fd-a69f-2fa2c27c5655/c9138202-41e9-4e22-874e-ca333a0b9249/А50-22000-2022__20240217.pdf?download=true", // Ссылка для загрузки файла
      "InstanceLevel": 1, // Уровень инстанции
      "Court": "АС Пермского края", // Название суда
      "Type": "Определение", // Тип документа
      // Массив с уточнением типа документа
      "ContentTypes": [
        "Об отложении рассмотрения заявления/жалобы"
      ]
    }
  ],
  "inquiry": {
    "price": 0.4,
    "balance": 990.4,
    "speed": 2,
    "attempts": 1
  }
}

Поиск не дал результата

{
  "status": 200,
  "PagesCount": 0,
  "TotalCount": 0,
  "NumOnPage": 0,
  "Page": 0,
  "Result": [],
  "inquiry": {
    "price": 0.4,
    "balance": 990,
    "speed": 1,
    "attempts": 1
  }
}

Поиск не дал результатов, либо ресурс не вернул ответа за отведенный промежуток времени

{"status":404, "error":"TIME_MAX_CONNECT", "errormsg":"Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата"}

Список disputeTypes (вид спора) для метода search

disputeTypes	Вид спора
1	Административный спор
2	Банкротство
3	Гражданский спор
4	дисциплинарные споры
5	НЕ ЗАДАН
6	о несостоятельности (банкротстве) организаций и граждан
7	о признании и приведении в исполнение решений иностранных судов и иностранных арбитражных решений
8	об административных правонарушениях
9	об оспаривании решений трет. судов и о выдаче исп. листов на принудительное исполнение решений трет. судов
10	об установлении фактов, имеющих юридическое значение
11	экономические споры по административным правоотношениям
12	экономические споры по гражданским правоотношениям

Список courts (суд) для метода search

courts	Наименование суда
VS	Верховный Суд РФ
VAS	Высший Арбитражный Суд РФ
FASVVO	АС Волго-Вятского округа
FASVSO	АС Восточно-Сибирского округа
FASDVO	АС Дальневосточного округа
FASZSO	АС Западно-Сибирского округа
FASMO	АС Московского округа
FASPO	АС Поволжского округа
FASSZO	АС Северо-Западного округа
FASSKO	АС Северо-Кавказского округа
FASUO	АС Уральского округа
FASCO	АС Центрального округа
1AAS	1 арбитражный апелляционный суд
2AAS	2 арбитражный апелляционный суд
3AAS	3 арбитражный апелляционный суд
4AAS	4 арбитражный апелляционный суд
5AAS	5 арбитражный апелляционный суд
6AAS	6 арбитражный апелляционный суд
7AAS	7 арбитражный апелляционный суд
8AAS	8 арбитражный апелляционный суд
9AAS	9 арбитражный апелляционный суд
10AAS	10 арбитражный апелляционный суд
11AAS	11 арбитражный апелляционный суд
12AAS	12 арбитражный апелляционный суд
13AAS	13 арбитражный апелляционный суд
14AAS	14 арбитражный апелляционный суд
15AAS	15 арбитражный апелляционный суд
16AAS	16 арбитражный апелляционный суд
17AAS	17 арбитражный апелляционный суд
18AAS	18 арбитражный апелляционный суд
19AAS	19 арбитражный апелляционный суд
20AAS	20 арбитражный апелляционный суд
21AAS	21 арбитражный апелляционный суд
ALTAI-KRAI	АС Алтайского края
AMURAS	АС Амурской области
ARHANGELSK	АС Архангельской области
ASTRAHAN	АС Астраханской области
BELGOROD	АС Белгородской области
BRYANSK	АС Брянской области
VLADIMIR	АС Владимирской области
VOLGOGRAD	АС Волгоградской области
VOLOGDA	АС Вологодской области
VORONEJ	АС Воронежской области
MSK	АС города Москвы
SPB	АС города Санкт-Петербурга и Ленинградской области
SEVASTOPOL	АС города Севастополя
DNR	АС Донецкой Народной Республики
EAO	АС Еврейской автономной области
CHITA	АС Забайкальского края
ZAPOROZHYE	АС Запорожской области
IVANOVO	АС Ивановской области
IRKUTSK	АС Иркутской области
ASKB	АС Кабардино-Балкарской Республики
KALININGRAD	АС Калининградской области
KALUGA	АС Калужской области
KAMCHATKA	АС Камчатского края
ASKCHR	АС Карачаево-Черкесской Республики
KEMEROVO	АС Кемеровской области
KIROV	АС Кировской области
KOMI-PERM	АС Коми-Пермяцкого АО
KOSTROMA	АС Костромской области
KRASNODAR	АС Краснодарского края
KRANSOYARSK	АС Красноярского края
KURGAN	АС Курганской области
KURSK	АС Курской области
LIPETSK	АС Липецкой области
LNR	АС Луганской Народной Республики
MAGADAN	АС Магаданской области
ASMO	АС Московской области
MURMANSK	АС Мурманской области
NNOV	АС Нижегородской области
NOVGOROD	АС Новгородской области
NOVOSIB	АС Новосибирской области
OMSK	АС Омской области
ORENBURG	АС Оренбургской области
OREL	АС Орловской области
PENZA	АС Пензенской области
PERM	АС Пермского края
PRIMKRAY	АС Приморского края
PSKOV	АС Псковской области
ADYG	АС Республики Адыгея
ALTAI	АС Республики Алтай
UFA	АС Республики Башкортостан
BURYATIA	АС Республики Бурятия
MAHACHKALA	АС Республики Дагестан
INGUSHETIA	АС Республики Ингушетия
KALMYK	АС Республики Калмыкия
KARELIA	АС Республики Карелия
KOMI	АС Республики Коми
KRYM	АС Республики Крым
MARI-EL	АС Республики Марий Эл
ASRM	АС Республики Мордовия
YAKUTSK	АС Республики Саха
ALANIA	АС Республики Северная Осетия
TATARSTAN	АС Республики Татарстан
TYVA	АС Республики Тыва
KHAKASIA	АС Республики Хакасия
ROSTOV	АС Ростовской области
RYAZAN	АС Рязанской области
SAMARA	АС Самарской области
SARATOV	АС Саратовской области
SAKHALIN	АС Сахалинской области
EKATERINBURG	АС Свердловской области
SMOLENSK	АС Смоленской области
STAVROPOL	АС Ставропольского края
TAMBOV	АС Тамбовской области
TVER	АС Тверской области
TOMSK	АС Томской области
TULA	АС Тульской области
TUMEN	АС Тюменской области
UDMURTIYA	АС Удмуртской Республики
ULYANOVSK	АС Ульяновской области
KHABAROVSK	АС Хабаровского края
HMAO	АС Ханты-Мансийского АО
KHERSON	АС Херсонской области
CHEL	АС Челябинской области
CHECHNYA	АС Чеченской Республики
CHUVASHIA	АС Чувашской Республики
CHUKOTKA	АС Чукотского АО
YAMAL	АС Ямало-Ненецкого АО
YAROSLAVL	АС Ярославской области
KUDIMKAR	ПСП Арбитражного суда Пермского края
NARYANMAR	ПСП Арбитражный суд Архангельской области
SIP	Суд по интеллектуальным правам

История изменений API ras.arbitr (Решения арбитражных судов)

дата	что изменилось
04.10.2024	Тип запроса search: Добавлены новые параметры поиска: 1. disputeTypes - Вид спора 2. courts - Суд Подробнее в документации

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

код (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 Достигнуто максимальное количество коннектов, при которых ресурс не вернул результата. Повторите попытку позже.
123	IP_NOT_REGISTERED_IN_THE_SYSTEM Сработала защита IP. Текущий IP не совпадает с заданным в ЛК
111	PARAMETER_CONFLICT Вы указали параметры, которые конфликтуют между собой. Например VIN и regNumber. Необходимо указать либо VIN либо regNumber, что-то одно.
1002	courts_INCORRECT_VALUE Суд не соответствует маске
1001	disputeTypes_INCORRECT_VALUE Вид спора не соответствует маске
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"}