Определения

MOSBILL API

ОПРЕДЕЛЕНИЯ

ПОДПИСКА – услуга, подразумевающая регулярные списания фиксированных сумм денежных средств и предоставляющая доступ к определенному контенту на весь период действия услуги.

ПОТОК – гибко настраиваемый субаккаунт партнера, предназначенный для выделения трафика определенной категории (тематика трафика, источник и т. д).

ТАРИФИКАТОР – комплекс оборудования и ПО Mosbill, осуществляющий взаимодействие с оператором в течении всего жизненного цикла подписки.

СЕРВИС – Согласованная с оператором витрина, предоставляющая абоненту оригинальный контент на платной основе.

LANDING – принадлежащая оператору страница подтверждения согласия с подключением услуги и списанием денежных средств, кастомизированная в соответствии с тематикой сервиса.

РОТАЦИЯ – механизм, позволяющий предложить абоненту альтернативный Landing, в случае отказа от подписки, либо ошибки на стороне Оператора.

TRAFFBACK_URL – url, задаваемый для переадресации абонента в случае невозможности подписки абонента на основной и альтернативный Landing.

BACKURL – url, задаваемый для каждого сервиса, для переадресации абонента в случае успешного подключения подписки.

NOTIFICATION_URL - url обработчика уведомлений на стороне партнера.

СЦЕНАРИЙ

АКТИВАЦИЯ ПОДПИСКИ

Для инициализации подписки Партнер вызывает метод begin_subscribe. В ответ тарификатор отдает уникальный идентификатор операции tid.

Получив идентификатор, партнер переадресует абонента на тарификатор, добавляя GET параметр, содержащий полученный ранее tid.

Тарификатор осуществляет переадресацию абонента на лэндинговую страницу Оператора, где абонент либо подтверждает свое согласие с услугой, либо отказ от нее.

После подтверждения абонентом согласия с услугой происходит переадресация абонента на BACKURL (по требованиям Оператора, абонент должен быть переадресован на страницу с контентом той тематики, на которую он подписался), а на обработчик партнера поступает уведомление о подключении услуги и списании денежных средств.

Важно понимать, что уведомление и переадресация абонента не связанные события. Уведомление может поступить как раньше чем произойдет переадресация абонента так и позже этого.

В случае отказа абонента, или невозможности подписки на стороне Оператора или тарификатора по ряду причин, тарификатор производит переадресацию абонента на URL, заданный Партнером для traffback_url.

При наличии в настройках Потока альтернативных лэндингов, тарификатор при отказе абонента или невозможности подписки на основной лэндинг, производит переадресацию абонента на альтернативные landing page, настроенные для потока. Если ни на одном из доступных landing page подписка не оформляется, тарификатор переадресует абонента на traffback_url.

       

ОПИСАНИЕ МЕТОДОВ

Метод begin_subscribe. Получение идентификатора транзакции.

Выполняется HTTP GET запросом на URL http://suscribe. mosbill. ru/begin_subscribe

Передаваемые параметры:

Параметр	Описание	Обязательный
stream_id	Идентификатор потока.	Да
Ip	IP-адрес абонента	Да, если отсутствует msisdn
crc	md5 контрольная сумма	Да
ext_id	Идентификатор транзакции на стороне партнера.	Нет
msisdn	Номер абонента	Да, если отсутствует IP

Пример запроса:

http://subscribe. mosbill. ru/begin_subscribe? streamid=8c1ea140-5318-11e5-a698-005056aafe8c&ip=69.30.231.66&crc=test_partner&ext_id=232

Пример ответа:

66d69022-90b5-4e34-ac8e-a6e7653c6200

Метод subscribe. Переадресация абонента на тарификатор.

Выполняется HTTP GET запросом на URL http://suscribe. mosbill. ru/subscribe

Передаваемые параметры:

Параметр	Описание	Обязательный
tid	Уникальный идентификатор транзакции	да

Пример запроса:

http://subscribe. mosbill. ru/subscribe? tid=66d69022-90b5-4e34-ac8e-a6e7653c6200

В ответ партнер получает HTTP код 302.

В заголовке Location будет ссылка на Landing page.

Метод redirect. Переадресация абонента на урл traffback_url

Выполняется HTTP GET запросом на URL traffback_url

Переадресация абонента на traffback_url, в случае невозможности подключения сервисов, настроенных для потока.

Переадресация осуществляется без каких-либо GET параметров.

Метод unsubscribe. Закрытие подписки, инициированное партнером.

Выполняется HTTP GET запросом на URL http://suscribe. mosbill. ru/unsubscribe

Передаваемые параметры:

Параметр	Описание	Обязательный
msisdn	Номер телефона абонента	да
service_id	Идентификатор сервиса, на который подписан абонент	да
stream_id	Идентификатор потока	да
crc	md5 контрольная сумма	Да

Пример запроса:

http://subscribe. mosbill. ru/unsubscribe? crc=test_partner&msisdn=79856351936&serviceid=86c46ce6-516a-11e5-a698-005056aafe8c&streamid=5ddb3262-5604-11e5-a698-005056aafe8c

В ответ партнер получает HTTP код 200.

Уведомление Партнера о событиях

Выполняется HTTP POST запросом на notification_url

Данные передаются в формате xml либо json, по желанию партнера.

Для каждого события высылается отдельное уведомление.

Передаваемые параметры:

Параметр	Описание
type	Тип события. Может принимать значения subscribe, prolong и close
notify_id	Уникальный идентификатор уведомления. Позволяет исключить повторную обработку уведомления, в случае переотправки.
timestamp	Метка времени события
partner_share	Размер отчислений партнера по конкретному событию
write_off	Сумма, списанная с абонента
subscription_id	Уникальный идентификатор подписки на стороне тарификатора
ext_id	Партнерский идентификатор подписки, переданный ранее при вызове метода begin_subscribe
service_id	Идентификатор сервиса на стороне тарификатора, на который в итоге подписался абонент.
stream_id	Идентификатор Потока
msisdn	Номер абонента в международном формате.
region	Идентификатор региона абонента.
operator	Название оператора абонента.

Примеры нотификации:

xml

<?xml version="1.0"?>   <event>   <type>PROLONG</type>   <notify_id>c12e3521-5799-11e5-a221-00259057bc07</notify_id>   <timestamp>1441879352</timestamp>   <partner_share>5.00</partner_share>   <write_off>20.00</write_off>   <subscription_id>73a2d437-579a-11e5-a221-00259057bc07</subscription_id>   <ext_id>7eaa80b0-579a-11e5-a221-00259057bc07</ext_id>   <service_id>55f155383f65f</service_id>   <stream_id>55f155383f69a</stream_id>   <msisdn>71111111111</msisdn>   <region>123</region>   <operator>mts</operator>   </event>

json

{"event":{"type":"PROLONG","notify_id":"c12e3521-5799-11e5-a221-00259057bc07", "timestamp":1441879352,"partner_share":"5.00","write_off":"20.00","subscription_id": "73a2d437-579a-11e5-a221-00259057bc07","ext_id":"7eaa80b0-579a-11e5-a221-00259057bc07","service_id":"55f155383f65f","stream_id":"55f155383f69a","msisdn": "71111111111","region":"123","operator":"mts"}}