Loyalty Program

Статус документа

Оглавление

Общая информация

Сервис Loyalty Program API используется для мотивации пользователей к установке приложения. Формат вывода: JSON.Для обращения за информацией клиент должен быть авторизован. Подробности в документации по Auth API.

Реферальная программа

Методы: bind, info.

Применение промокода «другом»

Параметры:

/loyaltyProgram/1/referral/bind.json?code=FBCFGCB&device_id=0500ae2dbc07e55e3823c25365f3684066f3290c&hash=c253255ad4e8388b426d623fcb323b626dfb5c17

Возвращаемый результат

Ответ

HTTP/1.1 200 OK
Content-Type: application/json

{
   "status": 1
   "description": "Promocode is binded"
}

Замечания:

• status — статус привязки промокода
  • 1 — Промокод привязан
  • 2 — Пользователь уже использовал данный промокод
  • 3 — Ошибка применения промокода (сюда попадают следующие ошибки: промокода не существует, не соответствует длина промокода)

• description — описание статуса (для разработчиков. В приложение не выводить (!))

Получить информацию о реферальной программе

Параметры:

/loyaltyProgram/1/referral/info.json?referral_program_id=1

Возвращаемый результат

Ответ

HTTP/1.1 200 OK
Content-Type: application/json

{
   "expired_in": 3600,
   "referral_program":
   {
       "referral_program_id": 1,    
       "signin_required": true,
       "code" : "FMTVRN",   
       "share_text": "Ваш промокод - FBCFGCB. Чтобы активировать подарок установите приложение и активируйте промокод в разделе \"Получить подарок\"",
       "details": [
            {
               "key": "Код активировали",
               "value": "52"  
            },
            {
                "key": "Бонусная подписка",
                "value": "1 месяц"
            }
        ],
       "special_conditional": "<p>Условия программы лояльности</p>"
    }
}

Замечания: - referral_program_id — Идентификатор реферальной программы. На будущее закладывается поддержка нескольких реферальных программ. - code — Пользовательский промокод - expired_in — Время в секундах актуальности ответа - signin_required — Признак авторизован ли пользователь - share_text — Текст, чтобы поделиться с другом - details — Детали применения реферальной программы
- special_conditional — Условия применения реферальной программы, поле передается в формате html

Алгоритм работы Реферальной программы:

1. Пользователь должен войти под своим логином и паролем.
2. После авторизации пользователю доступен раздел в мобильном приложении (МП) Приглашения и бонусы
3. Если пользователь не авторизован, МП предлагает пользователю залогинется.
4. Пользователь заходит в раздел Приглашения и бонусы
5. МП запускает метод info.
6. Бекенд проверяет, есть ли у пользователя реферальный код. Если у пользователя реферального кода нет, то бекенд его генерирует.
7. Пользователь вводит промокод друга. МП запускает метод bind Бекенд проверяет ограничения:
8. Пользователь может активировать промокод 1 раз на 1 устройстве
9. Промокодом может воспользоваться только новый пользователь (у которого ранее не было приложения PeersTv) Если ограничения соблюдены, то промокод считается активированным. Пользователю, применившему промокод, выдается подарок.
10. Бекенд переодически проверяет на соблюдение условий реферальной программы. При соблюдение данных условий, пользователь, выдавший промокод, получает «подарок». Если подарок получен, бекенд отправляет в МП пуш.

Изменения по версиям

Изменения в версии 1.1.0

• Начальная редакция документа.