Метод getLinks
Описание
Данный метод позволяет получить ссылки на страницу получения и обмен сертификата по идентификатору заявки (queue_id) или идентификатору заказа на платформе Giftery (order_id).
В случае, если getLinks был выполнен в тестовом режиме (testmode=1), данный метод вернёт ссылку на демо-сертификат Giftery при обращении по queue_id.
Параметры запроса (data)
В запросе обязательно нужно передать один из двух параметров. Если передать оба параметра, приоритет будет иметь параметр queue_id.
| Параметр | Описание |
|---|---|
| queue_id | Идентификатор заявки. Целое, больше нуля число. Возвращается методом makeOrder. |
| order_id | Идентификатор заказа (платформа Giftery). Целое, больше нуля число. |
Параметры ответа (data)
| Параметр | Описание |
|---|---|
| exchange_url | Ссылка на обмен сертификата. Если ссылки нет, возвращается null. |
| gift_page_url | Ссылка на страницу получения сертификата. Если ссылки нет, возвращается null. |
Пример
bash
# Получаем значение для подстановки SIG
# SECRET в данном случае - это хранящийся у клиента ключ для подписи запросов к API
$ echo -n 'getLinks{"queue_id":123456}SECRET' | sha256sum - | awk '{print $1}'
# Используем известный клиенту ID и сгенерированный SIG для выполнения запроса
$ curl 'https://ssl-api.giftery.ru/?cmd=getLinks&id=ID&in=json&out=json&data=%7B%22queue_id%22%3A123456%7D&sig=SIG'Пример результата успешного запроса
JSON
{
"status": "ok",
"data": {
"exchange_url": "https://activate.giftery.ru/exchange?code=99999-999-999-999&pin=9999",
"gift_page_url": "https://my.giftery.app/gift/new/19999991234567890"
}
}Результат в случае ошибки
JSON
{
"status": "error",
"error": {
"code": 1202,
"text": "Заказ не оплачен"
}
}| Код ошибки | Описание |
|---|---|
| 3608 | Не указан ни один из обязательных параметров queue_id/order_id |
| 3609 | Неизвестный идентификатор заявки (queue_id = {queue_id}) |
| 3610 | Неизвестный идентификатор заказа (order_id = {order_id}) |
| 1202 | Заказ не оплачен. После начала обработки заказа данный статус может быть получен в течение одной-двух секунд. При получении данного статуса требуется повторить запрос через небольшой интервал времени. |
| 1205 | При обработке заказа возникла ошибка. Требуется обратиться за информацией по адресу dev@giftery.ru. |
| 1208 | Данный статус показывает, что заказ был принят и ему был присвоен статус отложенного заказа. См. описание отложенных заказов. |
| 1209 | Заказ ещё находится в очереди на обработку. Если запрос getLinks был выполнен сразу после makeOrder, в таком случае мы не успели начать обрабатывать заказ и требуется повторить запрос через минуту. Если данный статус держится несколько минут и более, значит мы получили большое количество заказов за небольшой интервал времени. Требуется подождать и повторить запрос. |