PIN-CODE API

Статус документа

Оглавление

Цель и смысл

Данный документ описывает реализацию поддержки пин кода для доступа к контенту 18+.

Сценарии

Предусмотрены следующие сценарии:

• Пользователь отключил пин-код. Для дальнейшей работы пин-код запрашиваться не будет.
• Пользователь установил пин-код.
• Пользователь ввел пин-код. Бекенд проверяет корректность введеного пин-кода.
• Пользователь оставил пин-код по умолчанию. Пин-код по умолчанию - 0000.

Взаимодействие с API

API подразумевает доступ только аутентифицированного пользователя (возможно, анонимного), пользующегося авторизованным приложением.

В следствие чего данное API должно быть доступно только по HTTPS. Формат запроса:

https://<path_to_api>/<api_version>/<method>.<format>?[params]

Где:

• path_to_api — путь до API, полученный в Регистратуре
• api_version — мажорная версия API (должна быть равна 1)
• method — метод, который производится над элементом
• format — формат упаковки данных:
  • json — JSON

Значения всех параметров перед передачей серверу необходимо кодировать для предотвращения неоднозначной интерпретации так, как это рекомендуется в RFC3986.

Коды ответов сервера должны соответствовать стандартным кодам HTTP-ответов для соответствующих ситуаций. Если по запросу не найдено никакой информации, сервер должен вернуть нормальный (код 200) пустой ответ.

Аутентификация

Для аутентификации пользователя клиент должен передать полученный ранее токен доступа, выданный Auth API контрагента, по схеме аутентификации в соответствии с типом токена.

Для авторизации по типу токена «Bearer» рекомендуется использовать HTTP заголовок Authorization, пример:

Authorization: Bearer 18dasd81230dah12032

Методы

establish - установить пин-код

Параметры:

Пример успешного взаимодействия

Запрос

GET /pin_code/1/establish.json?pin=1234
Authorization: Bearer 18dasd81230dah12032
Host: api.peers.tv

Возвращаемый результат

Возвращаемый результат — пустой ответ с HTTP–кодом ответа 2xx.

check - проверить корректность введенного пин-кода

Параметры:

Пример успешного взаимодействия

Запрос

GET /pin_code/1/check.json?pin=1234
Authorization: Bearer 18dasd81230dah12032
Host: api.peers.tv

Ответ

HTTP/1.1 200 OK
Content-Type: application/json

{
   "status": 1
   "description": "Pin-code is a valid"
}

Замечания:

• status — статус проверки пин-кода
  • 1 — Пин-код валиден
  • 2 — Пин-код не корректный

• description — описание статуса

Важно(!): Если пин-код у пользователя не установлен, то допускается пин-код по умолчанию - 0000.

disable - отключить пин-код

Пример успешного взаимодействия

Запрос

GET /pin_code/1/disable.json
Authorization: Bearer 18dasd81230dah12032
Host: api.peers.tv

Возвращаемый результат

Возвращаемый результат — пустой ответ с HTTP–кодом ответа 2xx.

code-available - проверить включена ли проверка пин-кода

Пример успешного взаимодействия

Запрос

GET /pin_code/1/code-available.json
Authorization: Bearer 18dasd81230dah12032
Host: api.peers.tv

Ответ

HTTP/1.1 200 OK
Content-Type: application/json

{
   "status": 1
   "description": "Pin-code is on"
}

Замечания:

• status — статус проверки пин-кода
  • 1 — Проверка пин-кода включена
  • 2 — Проверка пин кода выключена
  • 3 — Пин-код не установлен

• description — описание статуса

Изменения по версиям

Изменения в версии 1.1.0

• Начальная редакция документа.