Формат ответа на получение операции

Ответ API содержит информацию о статусе операции. Если операция завершена успешно, ответ будет также содержать идентификатор результирующей матрицы.

Параметры ответа

id

Идентификатор операции.

done

Логическое значение, указывающее текущий статус операции.

Значение false означает, что выполнение операции не завершено.

Значение true означает, что выполнение операции завершено.

response

Результат операции в случае успешного завершения операции.

matrixId
Идентификатор результирующей матрицы.
error

Информация об ошибке в случае сбоя операции.

code
Код состояния, который должен быть значением из кодов состояния RFC9110.
message
Сообщение об ошибке на английском языке.

Сообщения об ошибках операции

Code Description
500 Операция завершилась неудачей из-за внутренней ошибки сервера. Попробуйте повторить запрос генерации матрицы позже.

Сообщения об ошибках

Code Description
400 Запрос не содержит одного или нескольких обязательных параметров.
401 Запрос не содержит параметр apikey или указан неверный ключ.
429 Превышено количество запросов.
500 или 504 Системная ошибка сервера. Повторите запрос с небольшой задержкой.

Если при обработке запроса происходит ошибка, API возвращает сообщение с описанием ошибки в поле errors:

{"errors": ["Error with parameter \"origins\": Required"]}
{"errors": ["Key not found"]}
{"errors": ["Parameter 'apikey' is missing"]}