• Помощь
  • Войти
  • Регистрация
  • Помощь
  • Войти
  • Регистрация
Центр помощи/База знаний/API
Популярные запросы:виджет, выплаты, парковка домена

Документация Grattis API

16.12.2019 18.06.2021

Содержание

  • Интерактивная документация к API
  • Обязательные параметры запросов к API
  • Работа с каталогом
    • Все категории
    • Данные одной категории
    • Данные одной категории (аудио-поздравления, имена)
    • Данные выбранного имени
  • Аудио-поздравления
    • Данные поздравления
    • MP3 Аудио-поздравления
  • Имена
    • Все имена
    • Данные одного имени
  • Страны
    • Все поддерживаемые страны
    • Определение страны по IP
  • Статус отправителя (опция подпись)
    • Данные SenderStatus — статус отправителя (кем приходится — бабушка, друг, подруга и т. д.)
  • Оплата
    • Формирование заказа
    • Проверка статуса заказа
  • Статистика: детальная за один день
    • Кэширование статистики. Как сбросить кэш и получить актульные данные?

Интерактивная документация к API

https://promo-api.grattis.ru/explorer

Обязательные параметры запросов к API

partnerId — ваш идентификатор в партнерской программе

apiKeyId — ключ к API, получить его можно здесь: https://partner.grattis.ru/keys-api/new

Работа с каталогом

Каталог имеет структуру виде дерева, оно формируется за счет поля parentId (ссылка на идентификатор родителя). У верхнего уровня parentId равен 0.

Все категории

GET https://promo-api.grattis.ru/categories?partnerId=…&apiKeyId=…

Данные одной категории

GET https://promo-api.grattis.ru/categories/{id}?partnerId=…&apiKeyId=….

Где:
{id} — идентификатор нижней категории у которой нет потомков
Ответ: см. интерактивную документацию (Модель SiteCategory)

Данные одной категории (аудио-поздравления, имена)

Аудиопоздравления в списке отсортированы по популярности.

GET https://promo-api.grattis.ru/categories/{id}/data?partnerId=…&apiKeyId=….

Где:
{id} — идентификатор нижней категории у которой нет потомков

Ответ: 
{

typenumberТип данных (1 — список поздравлений, 2 — список имен)
data[…]Массив данных в зависимости от типа

}

Данные выбранного имени

GET https://promo-api.grattis.ru/categories/{id}/names/{nameId}/data?partnerId=…&apiKeyId=…

Где: 
{id} — идентификатор нижней категории 
{nameId} — идентификатор выбранного имени

Аудио-поздравления

Данные поздравления

GET https://promo-api.grattis.ru/audio-cards/{id}?partnerId=…&apiKeyId=…

Где:
{id} — идентификатор аудио-поздравления
 
Ответ:
См. интерактивную документацию (Модель AudioCard)

MP3 Аудио-поздравления

GET https://cdn-static.grattis.ru/cards/{id}.mp3

Где: 
{id} — идентификатор аудио-поздравления

Имена

Все имена

GET https://promo-api.grattis.ru/names?partnerId=..&apiKeyId=…

Ответ:
См. интерактивную документацию (Модель Names)

Данные одного имени

GET https://promo-api.grattis.ru/names/{id}?partnerId=…&apiKeyId=…

Где: 
{id} — идентификатор имени

Ответ:
См. интерактивную документацию (Модель Names)

Страны

Нужны для поддержки платежей и звонков в разные страны

см. интерактивную документацию (Модель Country)

Все поддерживаемые страны

GET https://promo-api.grattis.ru/countries?partnerId=…&apiKeyId=…

Ответ:
Array<Country> см. интерактивную документацию (Модель Country)

Определение страны по IP

GET https://promo-api.grattis.ru/countries/{ip}/detect?partnerId=…&apiKeyId=…

Где: 
{ip} — ip клиента

Ответ:
{
iso: “код страны”
}

Статус отправителя (опция подпись)

Опция подпись дает возможность клиенту, за дополнительную плату, подсказать имениннику, кто именно его поздравил.

Данные SenderStatus — статус отправителя (кем приходится — бабушка, друг, подруга и т. д.)

GET https://promo-api.grattis.ru/sender-statuses?partnerId=…&apiKeyId=…

Где: 
{id} — идентификатор статуса отправителя

Ответ:
Array<SenderStatus>
см. интерактивную документацию

Оплата

Формирование заказа

POST https://promo-api.grattis.ru/orders?partnerId=…&apiKeyId=…

BODY:

OrderData {

productId*numberИдентификатор аудио поздравления
phoneTo*stringТелефон получателя
phoneFrom*stringТелефон отправителя
countryTo*stringСтрана получателя (ISO например RU)
countryFrom*stringСтрана отправителя (ISO например RU)
dateTimeSend*numberЖелаемое время доставки (количество миллисекунд, прошедших с 1 января 1970)
signSenderStatusIdnumberИдентификатор статуса отправителя (опция «подпись»)
signNameIdnumberИдентификатор имени отправителя (опция «подпись»)
externalIdnumberВаш идентификатор заказа (для проверки статуса заказа)

}

Ответ: 
{
url: “ссылка на страницу оплаты”
}

Проверка статуса заказа

GET https://promo-api.grattis.ru/orders/external/{externalId}/status?partnerId=…&apiKeyId=…&date=

Где externalId — внешний идентификатор, передается при создании заказа, формируется на стороне партнера

Ответ: JSON — объект OrderStatus

OrderStatus {

statusPaymentnumberСтатус оплаты (0 — в процессе оплаты, 1 — оплачен, -1 платеж не прошел)
statusSendnumberСтатус доставки (0 — в процессе доставки, 1 — доставлен)

}

Статистика: детальная за один день

GET https://promo-api.grattis.ru/orders/statistics/day?partnerId=…&apiKeyId=…&date=

Где date — дата, за которую требуются данные по заказам, формат даты (yyyy-mm-dd)

Ответ: JSON — Массив объектов OrderStatisticsDay

OrderStatisticsDay {

idnumberИдентификатор заказа
externalIdnumberВнешний идентификатор
datestring($date-time)Дата заказа
promoTypestringТип промо
promoIdstringИдентификатор промо
promoTitlestringНазвание промо
phoneFromstringТелефон отправителя
countryFromstringСтрана отправителя (ISO например RU)
isPaymentbooleanОплачено?
paymentMethodstringМетод оплаты
moneynumberСколько заработал партнер
utm_sourcestring
utm_mediumstring
utm_campaignstring
utm_contentstring
utm_termstring
ipstringIP адрес клиента

}

Кэширование статистики. Как сбросить кэш и получить актульные данные?

У нас длительное кэширование данных до 4 дней. Чтобы сбросить кэш, попробуйте добавить лишний параметр ?v=1222 к запросу.

Материал был полезен?

1 Да  Нет

API

  • Документация Grattis API

База знаний

  • API
  • Выплаты
  • Инструменты
    • iFrame-разделы
    • Виджеты
    • Витрины
    • Другие инструменты
    • Рекламные ссылки
  • Кейсы и советы
  • Парковка домена
  • Реферальная программа
  • Статистика

Контакты поддержки

Написать письмо
Написать в Telegram
Написать в Viber
Написать в VK
Популярные запросы:виджет, выплаты, парковка домена