Серверное API монетизации#
Данное API может быть использовано для проверки валидности платежей с сервера разработчиков приложения.
Серверное API текущей версии находится по адресу: https://api.pay.gaimp.ru/api/v1/
Авторизация#
В текущей версии авторизация производится посредством API-ключа разработчика, который выдается модератором маркетплейса при регистрации. API ключ имеет вид: 3a1930c3-2584-4e93-8413-4d0f4f885ec2
При утере ключа мы не можем выдать его еще раз, поэтому он может быть только создан заново.
API ключ передается в заголовке запроса Authorization
в виде basic auth. Например:
Authorization: Basic eW91ci5hcHAuaWQ6M2ExOTMwYzMtMjU4NC00ZTkzLTg0MTMtNGQwZjRmODg1ZWMy
Где eW91ci5hcHAuaWQ6M2ExOTMwYzMtMjU4NC00ZTkzLTg0MTMtNGQwZjRmODg1ZWMy
- base64 от your.app.id:3a1930c3-2584-4e93-8413-4d0f4f885ec2
Методы API#
Перечень методов API v1:
Метод | Назначение | Параметры |
---|---|---|
GET /api/v1/apps/{app}/verify |
Проверка валидности заказа и получение информации по нему с сервера разработчика | app - applicationId вашего приложения (в path). order - id заказа (в query). orderToken - токен заказа (в query). |
GET /api/v1/apps/{app}/verify
#
Параметры:
Имя | Передается в | Тип | Назначение | Обязательный | Пример |
---|---|---|---|---|---|
app |
path | string | applicationId вашего приложения | Да | your.app.id |
order |
query | string, uuid | ID заказа | Да | 59be1400-cb83-49f0-903e-05591102ceee |
orderToken |
query | string | Токен заказа | Да | f1cbfd1f86f91ac6dd647db2076d83b1ccc9714e8719fb0fcd53d16dda3df014578a34d2b5b6f4e4e28d4c0d0ddf15f3f3980d623976257433c5d4bdb22f06999fe1235d9330501d25f09a0f967f53b5942aad3754236b8778849a1b748e71442ba955afec1eeeddb1b8bc4986e29063416a845a686330c67f566354b69c89f4 |
Возвращаемый объект:
{
"data": {
"app": "string", // (1)!
"cart": [
{
"amount": 0, // (2)!
"full_name": "string",
"price": 0, // (3)!
"sku": "string"
}
],
"error": "string", // (4)!
"ext": {
"developerPayload": "" // (5)!
},
"order_id": "string",
"order_token": "string",
"state": "PAYED" // (6)!
},
"error": {
"message": "string"
},
"message": "string"
}
- applicationId вашего приложения
- Количество купленного товара, обычно -
1
- Цена товара в копейках
- Непустая строка с ошибкой при ее наличии
- Любая строка, которую вы можете задать при создании заказа, передав
payload
в методcreateOrder
- Статус заказа, см. статусную модель заказа
Возможные коды ответа:
Код | Описание |
---|---|
200 |
OK |
400 |
Неверный формат входных данных, см. message и error.message |
401 |
Неверный заголовок авторизации |
500 |
Ошибка на стороне сервера |
Сущности API#
Базовый ответ#
- Любой объект
Поля:
Поле | Тип | Возможные значения |
---|---|---|
data |
object | Любой объект в зависимости от запроса |
message |
string | Сообщение сервера. OK - в случае успешности обработки запроса. error - в случае ошибки. |
error |
object | Детализация ошибки и null - при ее отсутствии. |