Overview of API functionality
What Is an API?
An API allows two independent software components to exchange information.
Authentication
Basic Authentication
eSputnik’s API uses HTTP Basic Access Authentication. You can generate an API key and use it for authentication.
With API keys, the external components can access your eSputnik account without transmitting the password.
The API key has access to your eSputnik account. 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 a username
- enter the API key value as a password
Bearer Authentication
You can generate API token to
- Generate events
- Generate past events
- Remove events
Date/time formats
The format of the passed dates and times is in compliance with ISO 8601 standard.
Date: YYYY-MM-DD
Date and time: YYYY-MM-DDTHH:mm
Time zone of user, who sends a request, is used
Currency format
The currency values are passed as an amount and a currency code in ISO 4217 format.
Supported currencies: USD, EUR, UAH.
Data charset
The default charset is UTF-8.
If you want to send or receive data in another charset use the following HTTP header:
Content-Type: application/json; charset=UTF-8
Results
HTTP-response with status code 2хх - The operation was completed successfully. The response payload depends on the current operation.
HTTP-response with status code 4хх - The operation was completed with an error. Text details can be added to the response body.
API addresses
All API requests to eSputnik are sent to https://esputnik.com/api/, where you should input one of our methods' addresses after the last slash. For example, https://esputnik.com/api/v1/account/info.