Developers
Contents
Термины
- Разработчик – пользователь Ace Stream, который зарегистрировался как "рабработчик приложений"
- Клиент API - пользователь, который имеет доступ к API
- Ключ пользователя - идентификатор пользователя в системе Ace Stream
- Опция - дополнительная сервисная/программная услуга Ace Stream, которая может быть активирована для конкретного ключа пользователя
- Приложение - приложение разработчика, которое работает с системой Ace Stream
Регистрация и получение ключа продукта
Предположим, что Вы решили создать приложение, которое работает с системой Ace Stream (например, плеер). Для этого Вам будет необходимо использовать API движка Ace Stream, для доступа к которому необходимо получить ключ продукта
Для этого Вам необходимо:
- зарегистрироваться в системе Ace Stream
- в разделе «Партнерка» нажать кнопку "Стать разработчиком"
- подтвердить свое согласие с условиями и нажать кнопку "Зарегистироваться"
После этого в меню слева появится раздел "Разработчик", в котором Вы можете посмотреть и изменить настройки API (API Key и API Secret), а также управлять своими приложениями в подразделе "Приложения".
Для того, чтобы получить ключ продукта для нового приложения, необходимо нажать кнопку "Зарегистрировать приложение" и заполнить появившуюся форму. Просьба предоставлять как можно больше информации о Вашем приложении в поле "Описание", так как это ускорит процедуру выдачи ключа продукта.
После регистрации приложения Вы увидите его в списке приложений со статусом "Не подтверждено". После того, как мы проверим Ваше приложение, Вы получите письмо с ключом продукта, в списке приложений статус изменится на "Подтверждено" и появится публичная часть ключа продукта. Полный ключ продукта в списке приложений не выводится из соображений безопасности.
Что такое API
API для разработчиков позволяет разработчикам активировать различные дополнительные опции пользователям своих приложений.
Как получить доступ к API
Когда пользователь Ace Stream получает статус "разработчик продуктов", он автоматически становится клиентом API и ему предоставляется доступ к API в виде двух идентификаторов:
- API key - строка, которая используется для идентификации пользователя в запросах API
- API secret - секретный ключ, который используется для цифровой подписи запросов API
Секретный ключ пользователь может поменять самостоятельно в админ-панели.
Активация опций для пользователя
Для того, чтобы активировать опцию пользователю, необходимо вызвать метод API activateService и передать ему такие параметры:
- API key
- публичная часть ключа продукта
- ключ пользователя
- идентификатор опции
- идентификатор периода, на который необходимо активировать опцию
При успешном выполнении запроса с баланса разработчика будет списана определенная сумма, а у пользователя активируется опция на указанный период.
Если у пользователя в данный момент уже активирована указанная опция, то срок действия опции продлится на указанный срок.
Как видно из описания, для активации опции разработчик должен знать ключ пользователя. Ключ можно получить с помощью метода API createUserKey. Созданный с помощью этого метода ключ пользователя необходимо добавить в движок с помощью метода сервисного API движка load_extension