Введение в eSputnik Public API
Introduction to eSputnik public API

Аутентификация
Authentication

Применяется HTTP Basic Access Authentication.
Мы предлагаем способ аутентификации с помощью API ключа.
Пожалуйста, учитывайте, что API ключ имеет доступ к вашему аккаунту в eSputnik. Мы рекомендуем хранить его в безопасном месте и не передавать через рисковые каналы связи.

Чтобы обратиться к ресурсам вашего аккаунта в eSputnik с помощью API ключа:
  • введите любое значение в поле username
  • введите значение API ключа в поле password
eSputnik API uses HTTP Basic Access Authentication.
We offer API key-based authentication.
Please note that the API key has access to your eSputnik account. Make sure you keep it secure and don’t expose it publicly in insecure communication channels.

To access your eSputnik account resources with the API key:
  • enter any value as the username
  • enter the API key value as the password

Передача значений даты/времени
Date/time formats

Значения даты/времени передаются в формате ISO 8601. Формат для даты: YYYY-MM-DD
Формат для даты со временем: YYYY-MM-DDTHH:mm

Используется таймзона пользователя, который отправляет запрос
Date/time values are transferred with ISO 8601 format.
Date format: YYYY-MM-DD
Date with time format: YYYY-MM-DDTHH:mm

Time zone of user, who sends a request, is used

Передача значений денежных единиц
Currency format

Значения денежных единиц передаются в виде суммы и кода валюты в формате ISO 4217.
Поддерживаемые валюты: UAH, RUB, USD.
Currency values are transferred as a sum of amount and currency code with ISO 4217 format.
Supported currencies: USD, UAH, RUB.

Кодировка данных
Data charset

По умолчанию используется кодировка UTF-8.
Если необходимо передать входные или получить исходящие данные в другой кодировке, то запрос должен содержать такой заголовок:

Content-Type: application/json; charset=UTF-8
Default charset is UTF-8.
If you want to sent or receive data in another charset use following HTTP-header:

Content-Type: application/json; charset=UTF-8

Результаты выполнения операций
Results

Операция завершилась успешно - ответ от сервера с кодом 2хх. Payload в ответе будет зависеть от выполняемой операции.
Операция завершилась с ошибкой - ответ от сервера с кодом 4хх. Возможно включение текстовой расшифровки в тело ответа.
The operation completed successfully - HTTP-response with status code 2хх. Response payload depends on current operation.
The operation completed with error - HTTP-response with status code 4хх. Text details can be added to a response body.