Объект PPV

Методы: create update delete list addmedia deletemedia listmedia addbuyer listbuyers

create

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

Обращаем внимание,

если вы создаете Доступ без параметра cost, вы создадите Доступ по паролю.

если вы создаете Доступ с параметром cost, вы создадите Платный Доступ.

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

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

  • String apikey (Api ключ)
  • String name (Название платного доступа)
  • Integer period (Период платного доступа)

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

  • String type (Тип платного доступа) Варианты: single (одиночный), group (групповой). По умолчанию single.
  • String description (Описание платного доступа)
  • Double cost (Стоимость платного доступа )

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

  • String Code (Код платного доступа)
  • String Name (Название платного доступа)
  • String Type (Тип платного доступа)
  • Double Cost (Цена платного доступа)
  • Integer Period (Период платного доступа)
  • 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>
      <Description>some text</Description>
    </Item>
  </Items>
  <Status>Success</Status>
</Response>

update

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

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

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

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

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

  • String name (Название платного доступа)
  • Double cost (Цена платного доступа)
  • Integer period (Период платного доступа)
  • String description (Описание платного доступа)

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

  • String Name (Название платного доступа)
  • Double Cost (Цена платного доступа)
  • Integer Period (Период платного доступа)
  • 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>
      <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>
      <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=code=X150Kl1d

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

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

listmedia

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

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

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

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

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

https://boomstream.com/api/ppv/listmedia?apikey=[API_KEY]&code=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 (Код медиа-файла)
  • String email (Почта покупателя)
  • Boolean notification (Нотифицировать на электронную почту)

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

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

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

<Response>
<Items>
    <Item>
      <Email>example@example.com</Email>
      <Hash>8c3c69ed789f7996a941abb59543e7ca</Hash>
      <Period>30</Period>
      <DatePurchase>2015-01-29 15:05:58</DatePurchase>
    </Item>
  </Items>
  <Status>Success</Status>
</Response>

listbuyers

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

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

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

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

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

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

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

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

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

<Response>
  <Items>
    <Item>
      <Email>example@example.com</Email>
      <Hash>8c3c69ed789f7996a941abb59543e7ca</Hash>
      <Recovery>4</Recovery>
      <Period>30</Period>
      <DatePurchase>2015-01-29 15:05:58</DatePurchase>
      <IsManual>true</IsManual>
    </Item>
  </Items>
  <Status>Success</Status>
</Response>