logo

Объект Project

API методы
функционал

Методы: create | info | list | update | delete

create

Создание нового проекта

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

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

  • String email (Email вашей учетной записи Boomstream)
  • String title (Название проекта)
  • String apikey (API ключ вашего проекта)

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

  • String ApiKey (API ключ созданного проекта)
  • String Title (Название созданного проекта)
  • String Code (Код созданного проекта)

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

Text 
https://boomstream.com/api/app/create?email=Qatest1@boomstream.com&title=title&apikey=2131231db150acbdb4823423423

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

XML 
<Response>
    <ApiKey>2fsdf1db152342342fsd2312fs0</ApiKey>
    <Code>TeRwmuvi</Code>
    <Title>title</Title>
    <Message>Application is successfully created</Message>
    <Status>Success</Status>
</Response>

info

Информация о проекте

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

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

  • String apikey (API ключ вашего проекта)

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

  • String Title (Название проекта)
  • String apikey (API ключ вашего проекта)
  • String Code (Код вашего проекта)

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

Text 
https://boomstream.com/api/app/info?apikey=2312a677bb5d2342342d2328

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

XML 
<Response>
    <Message>Application info</Message>
    <Title>Updated by API</Title>
    <ApiKey>2fsdf1db15023432424dfsd2312fs0</ApiKey>
    <Code>TeRwmuvi</Code>
    <Status>Success</Status>
</Response>

list

Список проектов

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

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

  • String email (Email вашей учетной записи Boomstream)
  • String apikey (API ключ вашего проекта)

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

Text 
https://boomstream.com/api/app/list?email=Qatest1@boomstream.com&apikey=2131231db150acbdb4823423423

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

XML 
<Response>
    <Items>
        <Item>
            <ApiKey>e40e3a89a8b39739ad8647885d234256</ApiKey>
            <Title>Updated by API</Title>
            <Code>OPkmGnkl</Code>
        </Item>
        <Item>
            <ApiKey>5698423f7c7bf64b572d92c907ad07c6</ApiKey>
            <Title>v2</Title>
            <Code>TeRwmuvi</Code>
        </Item>
    </Items>
    <Status>Success</Status>
</Response>

update

Изменение названия проекта

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

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

  • String title (Название проекта)
  • String apikey (API ключ проекта)

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

  • String ApiKey (API ключ проекта)
  • String Title (Название проекта)
  • String Code (Код вашего проекта)

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

Text 
https://boomstream.com/api/app/update?apikey=2312a67234234234d232888&title=newTestTitle

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

XML 
<Response>
    <Message>Application is successfully updated</Message>
    <Title>newTestTitle</Title>
    <ApiKey>5698423f7c7bf64b572d92c907ad07c6</ApiKey>
    <Code>TeRwmuvi</Code>
    <Status>Success</Status>
</Response>

delete

Удаление проекта

Примечание: Вся информация о проекте будет удалена: медиафайлы, папки, подписки, а затем и сам проект.

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

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

  • String email (Email пользователя, проект которого вы хотите удалить)
  • String apikey_delete (API ключ проекта для удаления)
  • String apikey (API ключ проекта пользователя)

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

Text 
https://boomstream.com/api/app/delete?apikey=3123122342342343cb064fd2328&apikey_delete=3123122342342343cb064fd2328&email=Qatest1@boomstream.com

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

XML 
<Response>
    <Message>Application is successfully deleted</Message>
    <Status>Success</Status>
</Response>