Внимание! Это устаревшая версия API!Список версий и ссылка на актуальную версию ЗДЕСЬ
Внимание! Получать информацию можно только о тех заказах, которые были ранее Вами добавлены в систему с помощью API.
Взаимодействие с API e-AutoPay происходит в формате JSON по правилам REST.
Преимущество JSON в большей компактности по сравнению с SOAP/XML, а также в скорости анализа запросов.
После выдачи заказа или его сохранения данные кешируются на 5 минут.
Во многих языках программирования существуют модули и библиотеки для работы с JSON. Ниже перечислены рекомендуемые модули и библиотеки для PHP.
Для получения доступа необходимо зарегистрироваться в личном кабинете и сгенерировать customer_api_key, а также получить
от пользователя e-autopay ключ user_api_key.
Доступ осуществляется путём передачи ключа пользователя e-autopay user_api_key и ключа пользователя API customer_api_key.
Входящие и выходящие данные сериализуются посредством JSON.
user_api_key/orders
{
"customer_api_key": "$customer_api_key",
"order": {
"customer" : {
"surname": "Иванов", // фамилия (необязательный)
"given_name": "Иван", // имя (необязательный)
"patronymic": "Иванович", // отчество (необязательный)
"country": "Россия", // страна (необязательный)
"state": "Курская область", // регион (необязательный)
"city": "Курск", // город (необязательный)
"zip": "123456", // индекс (необязательный)
"address": "ул. Пушкина, д. 1, кв. 2", // адрес (необязательный)
"email": "ivan.ivanov@example.net", // email (необязательный, если указан phone)
"phone": "+79991111111" // телефон (необязательный, если указан email)
},
"credentials": {
"created": "2014-01-01 00:00:00", // дата заказа
"currency": "руб", // валюта заказа
"delivery_cost": 100.00 // цена доставки (необязательное, по умолчанию 0.00)
},
"basket": [
{
"good_id": 1, // идентификатор товара
"cost": 1000.00, // цена товара
"quantity": 1 // количество товара
},
{
"good_id": 2, // идентификатор товара
"cost": 2000.00, // цена товара
"quantity": 2 // количество товара
}
]
}
}
{
"order": {
"order_id": 1234, // идентификатор заказа
"status": "new", // статус заказа
"status_date": "2014-01-01 00:00:00",// дата/время последней смены статуса
"confirmed": true, // факт подтверждения заказа
"customer" : {
"surname": "Иванов", // фамилия
"given_name": "Иван", // имя
"patronymic": "Иванович", // отчество
"country": "Россия", // страна
"state": "Курская область", // регион
"city": "Курск", // город
"zip": "123456", // индекс
"address": "ул. Пушкина, д. 1, кв. 2", // адрес
"email": "ivan.ivanov@example.net", // email
"phone": "+79991111111" // телефон
},
"credentials": {
"created": "2014-01-01 00:00:00", // дата заказа
"currency": "руб", // валюта заказа
"amount": 5000.00, // стоимость заказа
"delivery_cost": 100.00 // цена доставки (необязательное, по умолчанию 0.00)
},
"basket": [
{
"good_id": 1, // идентификатор товара
"cost": 1000.00, // цена товара
"quantity": 1 // количество товара
},
{
"good_id": 2, // идентификатор товара
"cost": 2000.00, // цена товара
"quantity": 2 // количество товара
}
]
}
}
user_api_key/orders/order_id?{"customer_api_key":"customer_api_key"}
{
"order": {
"order_id": 1234, // идентификатор заказа
"status": "new", // статус заказа
"status_date": "2014-01-01 00:00:00",// дата/время последней смены статуса
"confirmed": true, // факт подтверждения заказа
"customer" : {
"surname": "Иванов", // фамилия
"given_name": "Иван", // имя
"patronymic": "Иванович", // отчество
"country": "Россия", // страна
"state": "Курская область", // регион
"city": "Курск", // город
"zip": "123456", // индекс
"address": "ул. Пушкина, д. 1, кв. 2", // адрес
"email": "ivan.ivanov@example.net", // email
"phone": "+79991111111" // телефон
},
"credentials": {
"created": "2014-01-01 00:00:00", // дата заказа
"currency": "руб", // валюта заказа
"amount": 5000.00, // стоимость заказа
"delivery_cost": 100.00, // цена доставки (необязательное, по умолчанию 0.00)
"notes": "Бонус в подарок", // комментарий к заказу (необязательное)
"logist_comment": "Комментарии логистики", // комментарии логистики
"author_comment": "Комментарии автора" // комментарии автора
},
"basket": [
{
"good_id": 1, // идентификатор товара
"cost": 1000.00, // цена товара
"quantity": 1 // количество товара
},
{
"good_id": 2, // идентификатор товара
"cost": 2000.00, // цена товара
"quantity": 2 // количество товара
}
]
}
}
| Код | Описание |
|---|---|
| "new" | Новый |
| "confirmed" | Подтвержден оператором |
| "sent" | Отправлен клиенту |
| "cancelled" | Возврат |
| "in_hands_paid" | Вручен и оплачен |
| "unconfirmed" | Неподтвержден |
| "delayed" | Отсрочен |
| "refused" | Отказ |
| "delivered_unpaid" | Доставлен к месту получения |
| "ready_for_delivery" | Подготовлен к отправке |
| "problem" | Проблемный |
| "delivered_paid" | Вручен и оплачен |
| "pending" | Ожидает подтверждения (Call-центр) |
| "specified" | Уточненный |
| "in_hands_unpaid" | Вручен |
| "wanted" | В розыске |
| "absence" | Отсутствие продукта |
| "returned" | Получен возврат |
| "notice1" | Напоминание 1 |
| "notice2" | Напоминание 1 |
В случае возникновения ошибок - возвращается объект с описание ошибки
{
error: {
"code": "HTTP Код",
"message": "Сообщение"
}
}