1. Документация
  2. Документация API
  3. Объект PPV

Объект PPV

Методы: create | update | delete | list | addmedia | deletemedia | listmedia | addbuyer | updatebuyer | deletebuyer | listbuyers | contacts | updatecontacts

create

Создание ограниченного доступа.

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)
  • String name (Название платного доступа)
  • String subscription_type (Тип ограниченного доступа. Значения переменной: subscription - платный доступ, password - доступ по паролю, collection - сбор информации через форму регистрации)

Обязательные параметры (взаимоисключающие):

  • Integer period (Период платного доступа в днях)
  • Date access_expire (дата окончания доступа в формате YYYY-MM-DD, например, 2018-12-31. Также можно передать точное время, включая часы, минуты, секунды в формате YYYY-MM-DD H:i:s, например, 2018-12-31 14:01:55. Если точное время не передается, то оно устанавливается по умолчанию на 23:59:59)

Необязательные параметры:

  • String type (Тип платного доступа) Варианты: single (одиночный), group (групповой). По умолчанию single.
  • String description (Описание платного доступа)
  • Double cost (Стоимость платного доступа )
  • String collection_type (Только для subscription_type=collection. Значения: collect - разрешен доступ к медиа после регистрации и protect - разрешен доступ к медиа только если данные из формы совпадают с теми, что уже хранятся в нашей базе)
  • Date access_start (дата начала доступа в формате YYYY-MM-DD, например, 2018-12-31. Также можно передать точное время, включая часы, минуты, секунды в формате YYYY-MM-DD H:i:s, например, 2018-12-31 23:01:55. Если точное время не передается, то оно устанавливается по умолчанию на 00:00:01)
  • Integer activation (Количество активаций пароля)
  • String materials (Дополнительные материалы)
  • String buy_redirect_url (URL-адрес, куда перенаправляется зритель после покупки)
  • String custom_url (Ссылка в письме)
  • Boolean ip_recovery (Автоматически восстанавливать сессию по IP)
  • Boolean device_ban (Запрет на одновременный просмотр медиа по одному паролю с разных устройств)
  • Boolean buyer_commission (Комиссию платежного шлюза в размере 5% оплачивает покупатель)
  • Boolean downloadable_origin (Разрешить зрителю скачать видео после просмотра. Опция доступна только при выключенной опции DRM защиты от скачивания)
  • Integer preview (Время предпросмотра перед запросом оплаты. Опция доступна только при включенной опции DRM защиты от скачивания)
  • Boolean watermark (Включает показ водяного знака. Опция доступна только при включенной опции DRM защита от скачивания)
  • Boolean watermark_email (Отображать email зрителя в качестве водяного знака. Опция доступна только при включенной опции DRM защиты от скачивания)
  • Boolean watermark_name (Отображать Имя зрителя в качестве водяного знака. Поле имя можно заполнить при добавлении зрителя вручную. Опция доступна только при включенной опции DRM защита от скачивания)
  • Boolean watermark_ip (Отображать ip адрес зрителя в качестве водяного знака. Опция доступна только при включенной опции DRM защита от скачивания)

Выходные параметры

  • String Code (Код платного доступа)
  • String Name (Название платного доступа)
  • String Type (Тип платного доступа)
  • Double Cost (Цена платного доступа)
  • Integer Period (Период платного доступа)
  • DateTime AccessExpirationDate (дата окончания доступа)
  • String Description (Описание платного доступа)

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

https://boomstream.com/api/ppv/create?apikey=[API_KEY]&name=ppv&type=group&cost=100.00&period=1&description=some%20ftext

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

<Response>
  <Items>
    <Item>
      <Code>X150Kl1d</Code>
      <Name>ppv</Name>
      <Type>group</Type>  
      <Cost>100.00</Cost>
      <Period>1</Period>
      <AccessExpirationDate>2018-12-12 23:59:00</AccessExpirationDate>
      <Description>some text</Description>
    </Item>
  </Items>
  <Status>Success</Status>
</Response>

update

Обновление информации ограниченного доступа.

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)
  • String code (Код ограниченного доступа)

Необязательные параметры:

  • String name (Название платного доступа)
  • Double cost (Цена платного доступа)
  • String collection_type (Только для subscription_type=collection. Значения: collect - разрешен доступ к медиа после регистрации и protect - разрешен доступ к медиа только если данные из формы совпадают с теми, что уже хранятся в нашей базе)
  • Integer period (Период платного доступа)
  • Date access_expire (дата окончания доступа в формате YYYY-MM-DD, например, 2018-12-31. Также можно передать точное время, включая часы, минуты, секунды в формате YYYY-MM-DD H:i:s, например, 2018-12-31 23:01:55. Если точное время не передается, то оно устанавливается по умолчанию на 23:59:59)
  • Date access_start (дата начала доступа в формате YYYY-MM-DD, например, 2018-12-31. Также можно передать точное время, включая часы, минуты, секунды в формате YYYY-MM-DD H:i:s, например, 2018-12-31 23:01:55. Если точное время не передается, то оно устанавливается по умолчанию на 00:00:01)
  • String description (Описание платного доступа)
  • Integer activation (Количество активаций пароля)
  • String materials (Дополнительные материалы)
  • String buy_redirect_url (URL-адрес, куда перенаправляется зритель после покупки)
  • String custom_url (Ссылка в письме)
  • Boolean ip_recovery (Автоматически восстанавливать сессию по IP)
  • Boolean device_ban (Запрет на одновременный просмотр медиа по одному паролю с разных устройств)
  • Boolean buyer_commission (Комиссию платежного шлюза в размере 5% оплачивает покупатель)
  • Boolean downloadable_origin (Разрешить зрителю скачать видео после просмотра. Опция доступна только при включенной опции DRM защиты от скачивания)
  • Integer preview (Время предпросмотра перед запросом оплаты. Опция доступна только при включенной опции DRM защиты от скачивания)
  • Boolean watermark (Включает показ водяного знака. Опция доступна только при включенной опции DRM защита от скачивания)
  • Boolean watermark_email (Отображать email зрителя в качестве водяного знака. Опция доступна только при включенной опции DRM защиты от скачивания)
  • Boolean watermark_name (Отображать Имя зрителя в качестве водяного знака. Поле имя можно заполнить при добавлении зрителя вручную. Опция доступна только при включенной опции DRM защита от скачивания)
  • Boolean watermark_ip (Отображать ip адрес зрителя в качестве водяного знака. Опция доступна только при включенной опции DRM защита от скачивания)

Выходные параметры

  • String Name (Название платного доступа)
  • Double Cost (Цена платного доступа)
  • Integer Period (Период платного доступа)
  • DateTime AccessExpirationDate (дата окончания доступа)
  • String Description (Описание платного доступа)

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

https://boomstream.com/api/ppv/update?apikey=[API_KEY]&code=X150Kl1d&name=payperview&cost=500.00&period=10&description=text

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

<Response>
  <Items>
    <Item>
      <Code>X150Kl1d</Code>
      <Name>payperview</Name>
      <Cost>500.00</Cost>
      <Period>10</Period>
      <AccessExpirationDate>2018-12-12 23:59:00</AccessExpirationDate>
      <Description>text</Description>
    </Item>
  </Items>
  <Status>Success</Status>
</Response>

delete

Удаление ограниченного доступа.

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)
  • String code (Код ограниченного доступа)

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

https://boomstream.com/api/ppv/delete?apikey=[API_KEY]&code=X150Kl1d

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

<Response>
  <Status>Success</Status>
</Response>

list

Получить список ограниченных доступов.

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)

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

https://boomstream.com/api/ppv/list?apikey=[API_KEY]

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

<Response>
  <Items>   
    <Item>
      <Name>ppv</Name>
      <Code>X150Kl1d</Code>
      <Cost>100.00</Cost>
      <Period>100.00</Period>
      <AccessExpirationDate>2018-12-12 23:59:00</AccessExpirationDate>
      <AmountFiles>4</AmountFiles>
      <Type>group</Type>
      <AddedDate>2015-12-12 23:23:23</AddedDate>
      <Description>Test</Description>
    </item>
  </Items>  
  <Status>Success</Status>
</Response>

addmedia

Добавить медиа-файл в список ограниченного доступа.

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)
  • String code (Код ограниченного доступа)
  • String media (Код видео файла, Код трансляции или Код плейлиста)

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

https://boomstream.com/api/ppv/addmedia?apikey=[API_KEY]&code=X150Kl1d&media=X150Kl1d

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

<Response>
  <Medias>
    <Item>
      <Title>Тестовое видео</Title>
      <Code>xxxxxxxx</Code>
      <PublishKey></PublishKey>
      <OnlineStatus>False</OnlineStatus>
      <RecordStatus>False</RecordStatus>
      <Concurrent>0</Concurrent>
      <CreationDate>2015-01-29 15:05:58</CreationDate>
      <Type>video</Type>
      <Width>640</Width>
      <Height>480</Height>
      <MediaStatus>Done</MediaStatus>
      <Duration>14</Duration>
      <PlayerCode>&amp;lt;iframe ...... &amp;lt;/iframe&amp;gt;</PlayerCode>
              <DownloadLink>https://bs.boomstream.com/balancer/hash:1234567890/xxxxxxxx.orig</DownloadLink>
         <Poster>
           <Code>xxxxxxxx-a1</Code>
           <Width>640</Width>
           <Height>480</Height>
           <Url>https://bs.boomstream.com/balancer/xxxxxxxx-a1.jpg</Url>
         </Poster>
         <Transcodes>
           <Item>
             <Code>xxxxxxxx-f33ubar5</Code>
             <Title>240p</Title>
             <Width>320</Width>
             <Height>240</Height>
             <PseudoFLV>https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5.flv</PseudoFLV>
             <PseudoMP4>https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5.mp4</PseudoMP4>
             <AdobeHDS>https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5/manifest.f4m</AdobeHDS>
             <AppleHLS>https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5/playlist.m3u8</AppleHLS>
             <MicrosoftSmooth>
                       https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5/Manifest
             </MicrosoftSmooth>
           </Item>
         </Transcodes>
         <Adaptive>
	   <AppleHLS>https://bs.boomstream.com/adaptive/xxxxxxxx/playlist.m3u8</AppleHLS>
	 </Adaptive>
         <Screenshots>
           <Item>
             <Code>xxxxxxxx-a1</Code>
             <Width>640</Width>
             <Height>480</Height>
             <Url>https://bs.boomstream.com/balancer/xxxxxxxx-a1.jpg</Url>
            </Item>
          </Screenshots>
    </Item>
  </Medias>
  <Status>Success</Status>
</Response>

deletemedia

Удалить медиа-файл из списка ограниченного доступа.

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)
  • String code (Код ограниченного доступа)
  • String media (Код медиа-файла)

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

https://boomstream.com/api/ppv/deletemedia?apikey=[API_KEY]&code=X150Kl1d&media=xxxxxxxx

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

<Response>
  <Status>Success</Status>
</Response>

listmedia

получить список медиа-файлов ограниченного доступа.

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)
  • String code (Код ограниченного доступа)

Необязательные параметры:

  • Integer limit (Количество записей)
  • Integer offset (Смещение. Задает, с какой по порядку записи показывать список).

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

https://boomstream.com/api/ppv/listmedia?apikey=[API_KEY]&code=X150Kl1d

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

<Response>
  <Medias>
    <Item>
       <Title>Тестовое видео</Title>
       <Code>xxxxxxxx</Code>
       <PublishKey></PublishKey>
       <OnlineStatus>False</OnlineStatus>
       <RecordStatus>False</RecordStatus>
       <Concurrent>0</Concurrent>
       <CreationDate>2015-01-29 15:05:58</CreationDate>
       <Type>video</Type>
       <Width>640</Width>
       <Height>480</Height>
       <MediaStatus>Done</MediaStatus>
       <Duration>14</Duration>
       <PlayerCode>&amp;lt;iframe ...... &amp;lt;/iframe&amp;gt;</PlayerCode>
              <DownloadLink>https://bs.boomstream.com/balancer/hash:1234567890/xxxxxxxx.orig</DownloadLink>
       <Poster>
         <Code>xxxxxxxx-a1</Code>
         <Width>640</Width>
         <Height>480</Height>
         <Url>https://bs.boomstream.com/balancer/xxxxxxxx-a1.jpg</Url>
       </Poster>
       <Transcodes>
        <Item>
          <Code>xxxxxxxx-f33ubar5</Code>
          <Title>240p</Title>
          <Width>320</Width>
          <Height>240</Height>
          <PseudoFLV>https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5.flv</PseudoFLV>
          <PseudoMP4>https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5.mp4</PseudoMP4>
          <AdobeHDS>https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5/manifest.f4m</AdobeHDS>
          <AppleHLS>https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5/playlist.m3u8</AppleHLS>
          <MicrosoftSmooth>
            https://bs.boomstream.com/balancer/xxxxxxxx-f33ubar5/Manifest
          </MicrosoftSmooth>
        </Item>
      </Transcodes>
      <Adaptive>
        <AppleHLS>https://bs.boomstream.com/adaptive/xxxxxxxx/playlist.m3u8</AppleHLS>
      </Adaptive>
      <Screenshots>
        <Item>
          <Code>xxxxxxxx-a1</Code>
          <Width>640</Width>
          <Height>480</Height>
          <Url>https://bs.boomstream.com/balancer/xxxxxxxx-a1.jpg</Url>
        </Item>
      </Screenshots>
    </Item>
  </Medias>
  <Status>Success</Status>
</Response>

addbuyer

Добавить покупателя в ограниченный доступ.

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)
  • String code (Код ограниченного доступа)
  • String media (Код медиа-файла)
  • Boolean notification (Нотифицировать на электронную почту)

Альтернативные параметры:

  • String email (Почта покупателя)
  • String phone (Телефон покупателя. Нотификации на номер не отправляются.)

Необязательные параметры:

  • String name (Имя покупателя)
  • Integer activation (Количество активаций пароля)
  • String custom_url (Ссылка в письме)
  • Date access_start (дата начала доступа в формате YYYY-MM-DD, например, 2018-12-31. Также можно передать точное время, включая часы, минуты, секунды в формате YYYY-MM-DD H:i:s, например, 2018-12-31 23:01:55. Если точное время не передается, то оно устанавливается по умолчанию на 00:00:01)
  • Date access_expire (дата окончания доступа в формате YYYY-MM-DD, например, 2018-12-31. Также можно передать точное время, включая часы, минуты, секунды в формате YYYY-MM-DD H:i:s, например, 2018-12-31 14:01:55. Если точное время не передается, то оно устанавливается по умолчанию на 23:59:59)
  • Boolean use_subscription_custom_url (Использовать ссылку в письме, указанную в платном доступе)

Если передается оба параметра custom_url и use_subscription_custom_url, то приоритет у custom_url

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

https://boomstream.com/api/ppv/addbuyer?apikey=[API_KEY]&code=X150Kl1d&media=xxxxxxxx&email=example@example.com&notification=1

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

<Response>
<Items>
    <Item>
      <Email>example@example.com</Email>
      <Hash>123456789</Hash>
      <Period>30</Period>
      <Recovery>4</Recovery>
      <DatePurchase>2015-01-29 15:05:58</DatePurchase>
      <AccessDateStart>2021-12-30 14:01:55</AccessDateStart>
      <AccessExpirationDate>2018-12-31 23:59:00</AccessExpirationDate>
      <Message>Added success</Message>
    </Item>
  </Items>
  <Status>Success</Status>
</Response>

updatebuyer

Изменить параметры доступа.

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)
  • String code (Код ограниченного доступа)
  • String hash (Пароль доступа)

Необязательные параметры:

  • String name (Имя покупателя)
  • Date access_start (дата начала доступа в формате YYYY-MM-DD, например, 2018-12-31. Также можно передать точное время, включая часы, минуты, секунды в формате YYYY-MM-DD H:i:s, например, 2018-12-31 23:01:55. Если точное время не передается, то оно устанавливается по умолчанию на 00:00:01)
  • Date access_expire (дата окончания доступа в формате YYYY-MM-DD, например, 2018-12-31. Также можно передать точное время, включая часы, минуты, секунды в формате YYYY-MM-DD H:i:s, например, 2018-12-31 14:01:55. Если точное время не передается, то оно устанавливается по умолчанию на 23:59:59)
  • Integer activation (Количество активаций пароля)

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

https://boomstream.com/api/ppv/updatebuyer?apikey=[API_KEY]&code=X150Kl1d&hash=12345678&activation=4&access_expire=2018-12-31

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

<Response>
    <Message>Recovery code is updated</Message>
    <Status>Success</Status>
</Response>

deletebuyer

Удалить пароль доступа.

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)
  • String code (Код ограниченного доступа)
  • String hash (Пароль доступа)

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

https://boomstream.com/api/ppv/deletebuyer?apikey=[API_KEY]&code=X150Kl1d&hash=12345678

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

<Response>
    <Message>Recovery code is deleted</Message>
    <Status>Success</Status>
</Response>

listbuyers

Список все покупателей ограниченного доступа.

Актуальная версия - 1.1

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)
  • String code (Код ограниченного доступа)
  • String media (Код медиа-файла)

Необязательные параметры:

  • String email (Фильтрация по электронному адресу покупателя) Поле электронного адреса не является уникальным для покупателя, поэтому вы можете получить несколько результатов в ответе!

Выходные параметры

  • String Email (Email покупателя)
  • String Hash (Пароль доступа)
  • Integer Recovery (Количество активаций пароля для покупателя)
  • Integer Period (Период доступа к платному доступу)
  • Date AccessExpirationDate (дата окончания доступа)
  • String DataPurchase (Дата приобретения подписки к платному доступу)
  • Boolean IsManual (Пользователь добавлен вручную)

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

https://boomstream.com/api/ppv/listbuyers?apikey=[API_KEY]&code=X150Kl1d&media=xxxxxxxx&email=buyer@example.com&ver=1.1

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

<Response>
  <Items>
    <Item>
      <Email>example@example.com</Email>
      <Hash>123456789</Hash>
      <Recovery>4</Recovery>
      <Period>30</Period>
      <AccessExpirationDate>2018-12-12 23:59:00</AccessExpirationDate>
      <DatePurchase>2015-01-29 15:05:58</DatePurchase>
      <IsManual>true</IsManual>
    </Item>
  </Items>
  <Status>Success</Status>
</Response>

contacts

Контакты продавца.

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)

Выходные параметры

  • String name (Название магазина/подавца)
  • String phone (Телефон магазина)
  • String email (Емайл магазина)
  • String site (Сайт магазина)
  • String description (Описание магазина)

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

https://boomstream.com/api/ppv/contacts?apikey=[API_KEY]

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

<Response>
  <Name>Alex</Name>
  <Phone>+0 000 000 000</Phone>
  <Email/>
  <Site/>
  <Description/>
  <Status>Success</Status>
</Response>

updatecontacts

Обновление/добавление контактов продавца.

Входные параметры

Обязательные параметры:

  • String apikey (Api ключ)
  • String name (Имя продавца)

Обязательные параметры (взаимоисключающие):

  • String phone (Телефон магазина)
  • String email (Емайл магазина)

Необязательные параметры:

  • String site (Сайт магазина)
  • String description (Описание магазина)

Выходные параметры

  • String name (Название магазина/подавца)
  • String phone (Телефон магазина)
  • String email (Емайл магазина)
  • String site (Сайт магазина)
  • String description (Описание магазина)

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

https://boomstream.com/api/ppv/updatecontacts?apikey=[API_KEY]&name=Alex&phone=+0 000 000 000

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

<Response>
  <Name>Alex</Name>
  <Phone>+0 000 000 000</Phone>
  <Email/>
  <Site/>
  <Description/>
  <Message>Updated success</Message>
  <Status>Success</Status>
</Response>