Appconfig API

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

Оглавление

Введение

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

Размещение и использование.

Точка входа определяется Регистратурой, где числовой идентификатор сервиса - 21, строковый - appconfig.

Запросы формируются следующим образом:

http://<path_to_api>/<api_version>/<method>.<format>?[parameters]

Где:

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

Методы Appconfig API

config - получение набора конфигурационных параметров для заданного приложения и платформы.

Формат ответа: ответ приходит в формате json с произвольным набором полей (ответ может быть пустым).

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

GET /appconfig/1/config.json?<platformName>&<platformVersion>&<appName>&<appVersion>
параметр описание возможные значения обязательный
platformName наименование платформы Tizen
Orsay
NetCast
Panasonic
Hisense
Infomir
OperaTV
WebOS
Browser
Zeasn		 да
platformVersion версия платформы строка нет
appName наименование приложения peerstv да
appVersion версия приложения строка нет
model модель устройства строка нет
firmware версия прошивки устройства строка нет
uid уникальный идентификатор устройства строка формата UUID нет

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

{
    "experiments": [
        "activate_main",
        "deactivate_vod"
    ],
    "hosted_url": "http://testsmart.cn.ru/orsay/test/index.html"
}

Параметры platformName и appName являются обязательными.

Значения параметров регистронезависимы.

Если клиент не передал параметры platformName и/или appName или передал некорректные параметры (значения параметров), то выдается ошибка с кодом 400.

История версий

Версия 1.0

Начальная версия (PTVRND–187)