API REFERENCE

Восстановление запроса

GET/api/v1/requests/{id}

Работает только с данными вашего аккаунта. Передавайте API-ключ в заголовке Authorization. Ответы возвращаются в JSON.

Запрос

В BASE_URL укажите HTTPS-адрес этого сайта, в API_KEY — свой секретный ключ. RESOURCE_ID замените идентификатором из ответа API.

cURL

curl --request GET "${BASE_URL}/api/v1/requests/RESOURCE_ID" \
  --header "Authorization: Bearer $API_KEY"

Заголовки и параметры

Authorizationобязательно

Bearer YOUR_API_KEY

idpath · stringобязательно

Числовой ID домена; UUID для заказа, операции или запроса.

Ответ

202 означает «принято», а не «выполнено». Проверяйте состояние заказа или операции. При неизвестном результате не создавайте повторную покупку. Суммы — десятичные строки в USD, даты — ISO 8601.

request_idstringобязательно

Идентификатор для восстановления результата после сетевого сбоя.

idstringобязательно

statusstringобязательно

Текущее состояние. Принятое задание ещё не означает успех.

responseobject | null

response_statusinteger | null

orderobject

operationobject

messagestring

Пример структуры ответа · условные значения

JSON

{
  "request_id": "00000000-0000-4000-8000-000000000001",
  "id": "string",
  "status": "string",
  "response": {},
  "response_status": 1,
  "order": "string",
  "operation": "string",
  "message": "string"
}

Ошибки и статусы

error.code · error.message · request_id

401

Ключ неверен или отозван.

404

Ресурс не найден в вашем аккаунте.

409

Конфликт ключа повтора или запрос ещё выполняется.

422

Неверные параметры или условия операции, включая баланс.

500

Результат может быть неизвестен. Проверьте запрос.

503

Временно недоступно. Учитывайте Retry-After.