Метод redeem
POST
Служит для обмена мультибрендового сертификата на выбранные бренды.
Параметры запроса
Примечание. Все поля обязательны.
| Параметр | Описание |
|---|---|
| code | Код/номер сертификата. |
| pin | Пин-код сертификата. |
| Email, на который будут отправлены выбранные сертификаты. | |
| list | Список выбранных продуктов. Каждый элемент списка представляет собой: id - ID продукта, face - выбранны номинал. |
Пример запроса
bash
curl -X POST \
https://activate.giftery.ru/api/v1/redeem \
-F code=99999-999-999-999 \
-F pin=9999 \
-F email=user@test.ru \
-F 'list[0][id]=705' \
-F 'list[0][face]=3000' \
-F 'list[1][id]=2213' \
-F 'list[1][face]=2000'Параметры ответа
| Параметр | Тип | Описание |
|---|---|---|
| status | string | Если запрос выполнился без ошибок, то вернётся ok, в противном случае - error. |
| code | string | Код ошибки |
| message | string | Текст сообщения об ошибке. |
Пример корректного ответа
В случае отсутствия ошибок в ответе вернётся только статус.
json
{
"status": "ok"
}Примеры ошибочных ответов
Ниже перечислены ошибочные варианты ответов при вызове метода redeem.
Не указан номер сертификата
JSON
{
"status": "error",
"code": "empty_code",
"message": "Не указан номер сертификата"
}Не указан пин-код сертификата
JSON
{
"status": "error",
"code": "empty_pin",
"message": "Не указан пин-код сертификата"
}Неверный формат email
JSON
{
"status": "error",
"code": "email_not_valid",
"message": "Неверный формат адреса"
}Не указаны сертификаты для обмена
JSON
{
"status": "error",
"code": "list_empty",
"message": "Не указаны сертификаты для обмена"
}Превышение количества выбранных брендов
JSON
{
"status": "error",
"code": "list_too_big",
"message": "Единоразово можно обменять не более 10-ти сертификатов"
}Неверно указан ID продукта
JSON
{
"status": "error",
"code": "redeem_failed",
"message": "Неверно указан ID продукта"
}