Page History

Versions Compared

Old Version 86

changes.mady.by.user user-f347e

Saved on Aug 02, 2018

compared with

New Version 87

changes.mady.by.user user-f347e

Saved on Aug 02, 2018

Key

This line was added.
This line was removed.
Formatting was changed.

Comment: Content imported from a Scroll Translations translation file.

...

Sv translation

language	pt

O MagicINFO Server permite-lhe implementar funções de gestão do conteúdo, de gestão de agendamentos e de gestão de dispositivos, bem como outras funções, chamando a Open API (v2.0).

Para utilizar a Open API (v2.0), terá de passar primeiro por um processo de autenticação. Utilize uma página swagger separada para testar cada API.

Autenticação

Quando chamar todos os itens da Open API (v2.0), é necessário incluir api_token no cabeçalho. Se o cabeçalho não contiver esta expressão, será devolvido um erro "401 Não Autorizado".

Os tokens obtidos expiram e deixarão de estar disponíveis após um período específico. Se tal acontecer, deve obter um token novo.

Pode chamar a API que se segue para obter api_token.

Nome do serviço	Chamada API	Tipo de chamada	Descrição
authenticationRequest	/auth	POST	Permite importar o valor de um token para efeitos de autenticação através da ID e da palavra-passe de utilizador.
authenticationRequest	/auth/refresh	GET	Permite criar um token novo para adiar a hora da expiração. É possível chamar a API REST sem iniciar sessão novamente.

OPEN API (v2.0)

A Open API (v2.0) do MagicINFO Server disponibiliza várias funções. A configuração de cada função encontra-se apresentada abaixo.

Categoria	Controlador	Descrição
Conteúdo	content-controller	Gestão de ficheiros de conteúdo
Conteúdo	content-group-controller	Gestão de grupos de conteúdo
Lista de reprodução	playlist-controller	Gestão de listas de reprodução
Lista de reprodução	playlist-group-controller	Gestão de grupos de listas de reprodução
Programar	content-schedule-controller	Gestão de agendamentos de conteúdo
	content-schedule-group-controller	Gestão de grupos de agendamentos de conteúdo
	message-schedule-controller	Gestão de agendamentos de mensagens
	message-schedule-group-controller	Gestão de grupos de agendamentos de mensagens
Dispositivo	device-controller	Gestão de dispositivos
Dispositivo	device-group-controller	Gestão de grupos de dispositivos
Utilizador	user-controller	Gestão de utilizadores
Utilizador	user-group-controller	Gestão de grupos de utilizadores
Definição	environment-controller	Definição

Conteúdo

Pode carregar, aprovar e eliminar conteúdo. Também pode fazer a gestão de listas de conteúdo. Os serviços relativos a conteúdo estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de conteúdo.

Os serviços de gestão do conteúdo disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
listAllContent	/restapi/v1.0/cms/contents	GET	Permite importar uma lista de conteúdo carregado. A lista inclui miniaturas, nomes, tipos de ficheiro e outras informações básicas sobre o conteúdo. É possível importar as listas por página através das informações de paginação.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Permite importar informações gerais sobre o conteúdo que será apresentado no painel de controlo.
listContent	/restapi/v1.0/cms/contents/filter	POST	Permite importar uma lista de conteúdo filtrado com base em condições. É possível importar as listas por página através das informações de paginação.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Permite eliminar conteúdo, quer o conteúdo esteja incluído numa lista de reprodução ou num agendamento ou não.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Permite eliminar conteúdo após se verificar que o conteúdo não está incluído numa lista de reprodução nem num agendamento. Se tentar eliminar conteúdo incluído numa lista de reprodução ou agendamento, este não será eliminado. Além disso, será devolvido um código de erro.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Permite importar detalhes sobre uma versão ativada de conteúdo. A versão do conteúdo é atualizada sempre que o conteúdo é editado.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Permite aprovar/rejeitar conteúdo. O conteúdo aprovado é movido para a lista de conteúdo geral e pode ser utilizado em listas de reprodução ou agendamentos.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Permite carregar conteúdo novo.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Permite importar uma lista de grupos de conteúdo predefinido.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Permite importar uma lista de subgrupos do grupo {groupId}.

Lista de reprodução

Pode utilizar conteúdo para criar, editar ou eliminar listas de reprodução. Os serviços relativos a listas de reprodução estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de conteúdo.

Os serviços de gestão de listas de reprodução disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Permite importar uma lista de todas as listas de reprodução. A lista inclui nomes de listas de reprodução, miniaturas do conteúdo principal, tipos de listas de reprodução e outras informações básicas. É possível importar as listas por página através das informações de paginação.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Permite criar uma nova lista de reprodução.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Permite importar informações necessárias sobre a lista de reprodução a partir do painel de controlo.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Permite importar uma lista de listas de reprodução filtradas com base em condições. É possível importar as listas por página através das informações de paginação.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Permite eliminar a lista de reprodução selecionada. Se tentar eliminar uma lista de reprodução incluída num agendamento, esta não será eliminada. Além disso, será devolvido um código de erro.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Permite importar detalhes sobre uma versão ativada de uma lista de reprodução. A versão da lista de reprodução é atualizada sempre que a lista de reprodução é editada.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Permite editar a lista de reprodução {playlistId}. A edição de uma lista de reprodução atualiza a respetiva versão e faz com que o dispositivo que reproduz a lista de reprodução reproduza automaticamente a lista de reprodução atualizada.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Permite copiar a lista de reprodução {playlistId}. É criada uma cópia duplicada da lista de reprodução.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Permite importar uma lista de grupos de listas de reprodução predefinidas.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Permite importar uma lista de subgrupos do grupo {groupId}.

Programar

Pode criar conteúdo ou agendamentos de mensagens novos. Também pode publicar agendamentos em dispositivos para reprodução, bem como editar ou eliminar agendamentos.

Os serviços relativos a agendamentos estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de agendamentos.

Os serviços de gestão de agendamentos disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Permite importar uma lista de todos os agendamentos de conteúdo. A lista inclui nomes de agendamentos de conteúdo, datas de criação, tipos de dispositivo e outras informações básicas. É possível importar as listas por página através das informações de paginação.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Permite criar um novo agendamento de conteúdo. Um agendamento de conteúdo poderá conter vários canais e fotogramas. Permite publicar um agendamento em dispositivos e reproduzir o conteúdo ou a lista de reprodução pretendido a uma determinada hora.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Permite importar informações necessárias sobre o agendamento de conteúdo a partir do painel de controlo.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Permite importar uma lista de agendamentos de conteúdo filtrados com base em diferentes condições. É possível importar as listas por página através das informações de paginação.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Permite eliminar um agendamento de conteúdo. Se eliminar um agendamento previamente publicado num dispositivo, este último reproduz automaticamente o conteúdo predefinido.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Permite importar detalhes do agendamento selecionado.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Permite editar um agendamento de conteúdo. Se editar um agendamento previamente publicado num dispositivo, este último reproduz automaticamente o agendamento editado.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Permite copiar o agendamento de conteúdo {programId}. É criada uma cópia duplicada do agendamento de conteúdo {programId}.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Permite publicar um agendamento de conteúdo num grupo de dispositivos específico.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Permite importar o estado de transferência de agendamentos de conteúdo em tempo real a partir de um dispositivo.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Permite importar uma lista de grupos de raiz para um agendamento de conteúdo.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Permite importar uma lista de todos os agendamentos de mensagens.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Permite criar um novo agendamento de mensagens.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Permite importar uma lista de agendamentos de mensagens filtrados com base em diferentes condições. É possível importar as listas por página através das informações de paginação.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Permite eliminar o agendamento de mensagens selecionado. Se eliminar um agendamento de mensagens previamente publicado num dispositivo, a alteração é automaticamente aplicada no dispositivo.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Permite importar detalhes do agendamento de mensagens selecionado.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Permite editar o agendamento de mensagens selecionado. Se editar um agendamento de mensagens previamente publicado num dispositivo, a alteração é automaticamente aplicada no dispositivo.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Permite copiar o agendamento de mensagens selecionado. É criada uma cópia duplicada do agendamento de mensagens.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Permite publicar o agendamento de mensagens selecionado num grupo de dispositivos.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Permite importar uma lista de grupos de raiz para um agendamento de conteúdo.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Permite importar uma lista de subgrupos de um grupo específico.

Dispositivo

Pode controlar e gerir dispositivos. Os serviços relativos a dispositivos estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de dispositivos.

Os serviços de gestão de dispositivos disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
listAllDevice	/restapi/v1.0/rms/devices	GET	Permite importar uma lista de todos os dispositivos. A lista inclui o estado da energia do dispositivo, informações sobre as miniaturas, o estado de erro do dispositivo e outras informações básicas. É possível importar as listas por página através das informações de paginação.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Permite importar informações necessárias sobre o dispositivo a partir do painel de controlo.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Permite importar uma lista de dispositivos filtrados com base em diferentes condições. É possível importar as listas por página através das informações de paginação.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Permite eliminar o dispositivo selecionado.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Permite importar detalhes do dispositivo selecionado.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Permite aprovar o dispositivo selecionado para um grupo específico.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Permite importar informações sobre cabinets ligados a um dispositivo LED. As informações importadas só são válidas quando os cabinets estão ligados a um dispositivo LED.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Permite editar informações sobre cabinets ligados a um dispositivo LED.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Permite importar informações de controlo de apresentação de dispositivos a partir da base de dados. Se não existirem informações de apresentação, deve enviar-se um pedido de informações para o dispositivo.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Permite enviar informações de controlo de apresentação editadas para um dispositivo. Só os valores editados que se encontram nas informações de apresentação são enviados sob a forma de protocolo para o dispositivo.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Permite receber informações de controlo de apresentação editadas de um dispositivo. Esta API é executável após a execução da API updateDisplayInfo.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Permite importar informações gerais de dispositivos a partir da base de dados. As informações gerais do dispositivo são atualizadas quando este se liga ao servidor.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Permite enviar informações de dispositivos editadas para um dispositivo. Só os valores editados que se encontram nas informações básicas de dispositivos são enviados sob a forma de protocolo para o dispositivo.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Permite receber informações de dispositivos a partir de um dispositivo. Esta API é executável após a execução da API updateGeneralInfo.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Permite mover um dispositivo para outro grupo.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Permite enviar um protocolo de início RM para um dispositivo. Os dispositivos que receberam um protocolo de início RM enviam periodicamente informações através do Servidor do Controlo Remoto.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Permite enviar um protocolo de paragem RM para um dispositivo. Os dispositivos que receberam um protocolo de paragem param imediatamente a função correspondente.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Permite importar definições de dispositivos. As definições do dispositivo são atualizadas quando este se liga ao servidor.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Permite enviar definições de dispositivos editadas para um dispositivo. Só os valores editados que se encontram nas definições são enviados sob a forma de protocolo para o dispositivo.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Permite receber definições de dispositivos a partir de um dispositivo. Esta API é executável após a execução da API updateSetupInfo.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Permite enviar um pedido atual de informações de controlo de apresentação para um dispositivo. Se se chamar esta API, requestId é devolvido como o valor de resposta.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Permite importar informações de controlo de apresentação enviadas a partir de um dispositivo. Esta opção é utilizada para duas ações: envio de um pedido de informações para um dispositivo e receção de informações reais do dispositivo.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Permite enviar um pedido atual de informações de hora para um dispositivo. Se se chamar esta API, requestId é devolvido como o valor de resposta.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Permite importar informações de hora enviadas a partir de um dispositivo. Esta opção é utilizada para duas ações: envio de um pedido de informações para um dispositivo e receção de informações reais do dispositivo.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Permite importar informações de hora de dispositivos a partir da base de dados. Se não existirem informações de apresentação, deve enviar-se um pedido de informações para o dispositivo.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Permite enviar informações de hora editadas para um dispositivo. Só os valores editados que se encontram nas informações de hora são enviados sob a forma de protocolo para o dispositivo.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Permite receber informações de hora de dispositivos a partir de um dispositivo. Esta API é executável após a execução da API getUpdatedTimeInfoResult.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Permite importar uma lista de organizações.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Permite importar informações sobre subgrupos de {groupId}.

Utilizador

Pode adicionar utilizadores e gerir informações dos mesmos. Os serviços relativos a utilizadores estão acessíveis a utilizadores autenticados com privilégios de leitura, escrita e gestão de informações de utilizadores.

Os serviços de gestão de utilizadores disponíveis são os seguintes:

Nome do serviço	Chamada API	Tipo de chamada	Descrição
createUser	/restapi/v1.0/ums/users	POST	Permite adicionar um utilizador.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Permite importar informações necessárias sobre utilizadores a partir do painel de controlo.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Permite editar informações de utilizadores.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Permite importar uma lista de organizações. Esta opção pode ser utilizada para configurar a árvore de um grupo.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Permite importar uma lista de organizações.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Permite importar detalhes do grupo {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Permite importar uma lista de subgrupos do grupo {groupId}.

Definição

Para além das funções principais, pode utilizar muitas outras funções para criar e gerir identificadores e categorias, bem como para editar o painel de controlo.

Nome do serviço	Chamada API	Tipo de chamada	Descrição
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Permite importar uma lista de categorias.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Permite eliminar informações de painel de controlo específicas.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Permite importar conteúdo que será apresentado no painel de controlo personalizado. Só é possível apresentar informações específicas no painel de controlo.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Permite alterar a ordem dos itens apresentados no painel de controlo.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Permite ativar um painel de controlo inativo.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Permite importar informações de início de sessão que serão apresentadas no painel de controlo.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Permite importar informações de quadro de avisos que serão apresentadas no painel de controlo.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Permite eliminar uma publicação de um quadro de avisos.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Permite importar detalhes da publicação selecionada.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Permite adicionar publicações ao quadro de avisos.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Permite editar a publicação selecionada no quadro de avisos.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Permite importar informações de armazenamento que serão apresentadas no painel de controlo.
listLicense	/restapi/v1.0/ems/license	GET	Permite importar uma lista de licenças registadas no servidor.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Permite importar definições do servidor. Os itens das definições do servidor incluem opções que podem ativar ou desativar as diferentes funções no servidor.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Permite importar uma lista de identificadores registados no servidor.

Detalhes da Open API (IU swagger)

http://184.169.167.38:7001/MagicInfo/swagger-ui.html

Sv translation

language	ru

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

Для того, чтобы использовать Open API (v2.0), сперва нужно пройти процедуру аутентификации. Используйте отдельную swagger-страницу для проверки каждого API.

Проверка подлинности

При вызове объектов Open API (v2.0) необходимо включить в заголовок api_token. В противном случае появится ошибка "401 Нет доступа".

Маркер доступа становится недоступным для использования по истечении срока действия. В этом случае необходимо получить новый маркер доступа.

Получить маркер доступа api_token можно путем вызова следующего api.

Название услуги	Вызов API	Тип вызова	Описание
Запрос «Аутентификация»	/auth	POST (создание)	Импорт значения маркера доступа для аутентификации с использованием ИД и пароля пользователя.
Запрос «Аутентификация»	/auth/refresh	GET (чтение)	Создание нового маркера доступа для продления срока действия. Вызов REST API можно осуществлять без повторного входа в систему.

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) предлагает множество функций. Конфигурация каждой функции представлена ниже.

Категория	Контроллер	Описание
Содержимое	content-controller	Управление файлом содержимого
Содержимое	content-group-controller	Управление группами содержимого
Плейлист	playlist-controller	Управление списком воспроизведения
Плейлист	playlist-group-controller	Управление группами списков воспроизведения
Расписание	content-schedule-controller	Управление расписаниями содержимого
	content-schedule-group-controller	Управление группами расписаний содержимого
	message-schedule-controller	Управление расписанием сообщений
	message-schedule-group-controller	Управление группами расписаний сообщений
Устройство	device-controller	Управление устройствами
Устройство	device-group-controller	Управление группами устройств
Пользователь	user-controller	Управление пользователями
Пользователь	user-group-controller	Управление группами пользователей
Настройка	environment-controller	Настройка

Содержимое

Загрузить, подтвердить или удалить содержимое. Управление списками содержимого Службы для работы с содержимым доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление содержимым.

Ниже приведены доступные службы управления содержимым:

Название услуги	Вызов API	Тип вызова	Описание
listAllContent	/restapi/v1.0/cms/contents	GET (чтение)	Импорт списка всего загруженного содержимого. Список содержит эскизы, имена, типы файлов и другие основные сведения. Загружать списки можно постранично, используя постраничную информацию.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET (чтение)	Импорт общих сведений о содержимом, отображаемом на панели управления.
listContent	/restapi/v1.0/cms/contents/filter	POST (создание)	Импорт списка содержимого, отсортированного по параметрам. Загружать списки можно постранично, используя постраничную информацию.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE (удалить)	Удаление содержимого вне зависимости, включено оно в список воспроизведения или расписание.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE (удалить)	Удаление содержимого после проверки его содержания в списке воспроизведения или расписании. Если содержимое включено в список воспроизведения или расписание, то при попытке его удаления отобразится код ошибки.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET (чтение)	Импорт подробных сведений об активированной версии списка содержимого. Версия списка содержимого обновляется каждый раз при его изменении.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT (заполнение)	Подтверждение/отклонение содержимого. Подтвержденное содержимое перемещается в общий список и может использоваться в списках воспроизведения или расписаниях.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST (создание)	Загрузка нового содержимого.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET (чтение)	Импорт перечня групп содержимого по умолчанию.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET (чтение)	Импорт подробных сведений о {groupId} группе.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET (чтение)	Импорт списка подгрупп под указанной {groupId} группой.

Плейлист

Используйте содержимое для создания, изменения или удаления списков воспроизведения. Службы для работы со списками воспроизведения доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление содержимым.

Ниже приведены доступные службы управления списками воспроизведения:

Название услуги	Вызов API	Тип вызова	Описание
listAllPlaylist	/restapi/v1.0/cms/playlists	GET (чтение)	Импорт перечня всех списков воспроизведения. Перечень содержит имена списков воспроизведения, эскизы основного содержимого, типы списков воспроизведения и другие основные сведения. Загружать списки можно постранично, используя постраничную информацию.
createPlaylist	/restapi/v1.0/cms/playlists	POST (создание)	Создание нового списка воспроизведения.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET (чтение)	Импорт необходимых сведений о списке воспроизведения с приборной панели.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST (создание)	Импорт перечня списков воспроизведения, отсортированных по параметрам. Загружать списки можно постранично, используя постраничную информацию.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE (удалить)	удаление выбранного списка воспроизведения. Если список воспроизведения включен в расписание, то при попытке его удаления отобразится код ошибки.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET (чтение)	Импорт подробных сведений об активированной версии списка воспроизведения. Версия списка воспроизведения обновляется каждый раз при его изменении.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT (заполнение)	Изменение {playlistId} списка воспроизведения. При изменении списка воспроизведения его версия обновляется, таким образом устройство автоматически проигрывает обновленный список воспроизведения.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT (заполнение)	Копирование {playlistId} списка воспроизведения. Создается дубликат списка воспроизведения.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET (чтение)	Импорт перечня групп списков воспроизведения по умолчанию.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET (чтение)	Импорт подробных сведений о {groupId} группе.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET (чтение)	Импорт списка подгрупп под указанной {groupId} группой.

Расписание

Создание нового содержимого или расписания сообщений. Публикация расписания для воспроизведения на устройствах. Изменение или удаление расписаний.

Службы для работы с расписаниями доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление расписаниями.

Ниже приведены доступные службы управления расписаниями:

Название услуги	Вызов API	Тип вызова	Описание
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET (чтение)	Импорт перечня всех расписаний содержимого. Перечень содержит имена расписаний содержимого, даты создания, типы устройств и другие основные сведения. Загружать списки можно постранично, используя постраничную информацию.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST (создание)	Создание нового расписания содержимого. Расписание содержимого может содержать несколько каналов и кадров. Публикация расписания на устройствах и воспроизведение нужного содержимого или списка воспроизведения в указанное время.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET (чтение)	Импорт необходимых сведений о расписании содержимого с приборной панели.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST (создание)	Импорт списка расписаний содержимого, отсортированных по различным параметрам. Загружать списки можно постранично, используя постраничную информацию.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE (удалить)	Удаление расписания содержимого. При удалении расписания, ранее опубликованного на устройстве, автоматически выполняется воспроизведение содержимого по умолчанию.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET (чтение)	Импорт подробных сведений о выбранном расписании.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT (заполнение)	Изменение расписания файла содержимого. При изменении расписания, ранее опубликованного на устройстве, автоматически выполняется воспроизведение отредактированного расписания.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT (заполнение)	Копирование {programId} расписания содержимого. Создается дубликат расписания содержимого {programId}.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT (заполнение)	Публикация расписания содержимого в указанной группе устройств.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET (чтение)	Импорт состояния загрузки расписания содержимого в режиме реального времени с устройства.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET (чтение)	Импорт списка исходных групп для расписания содержимого.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET (чтение)	Импорт подробных сведений о {groupId} группе.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET (чтение)	Импорт списка всех расписаний сообщений.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST (создание)	Создание нового расписания сообщений.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST (создание)	Импорт списка расписаний сообщений, отсортированных по различным параметрам. Загружать списки можно постранично, используя постраничную информацию.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE (удалить)	Удаление выбранного расписания сообщений. При удалении расписания сообщений, ранее опубликованного на устройстве, внесенные изменения применяются автоматически.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET (чтение)	Импорт подробных сведений о выбранном расписании сообщений.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT (заполнение)	Изменение выбранного расписания сообщений. При изменении расписания сообщений, ранее опубликованного на устройстве, внесенные изменения применяются автоматически.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT (заполнение)	Копирование выбранного расписания сообщений. Создается дубликат расписания сообщений.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT (заполнение)	Публикация выбранного расписания сообщений в группе устройств.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET (чтение)	Импорт списка исходных групп для расписания содержимого.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET (чтение)	Импорт подробных сведений о {groupId} группе.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET (чтение)	Импорт списка подгрупп под указанной группой.

Устройство

Контроль и управление устройствами. Службы по работе с устройствами доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление устройствами.

Ниже приведены доступные службы управления устройствами:

Название услуги	Вызов API	Тип вызова	Описание
listAllDevice	/restapi/v1.0/rms/devices	GET (чтение)	Импорт списка всех устройств. Список содержит состояние питания устройства, информацию об эскизе, статусы ошибок устройства и другие основные сведения. Загружать списки можно постранично, используя постраничную информацию.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET (чтение)	Импорт необходимых сведений об устройстве с приборной панели.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST (создание)	Импорт списка устройств, отсортированных по различным параметрам. Загружать списки можно постранично, используя постраничную информацию.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE (удалить)	удаление выбранного устройства.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET (чтение)	Импорт подробных сведений о выбранном устройстве.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT (заполнение)	Подтверждение выбранного устройства в указанной группе.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST (создание)	Импорт сведений о блоках, подключенных к светодиодному устройству. Полученные сведения действительны только при условии подключения блоков к светодиодному устройству.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT (заполнение)	Изменение сведений о блоках, подключенных к светодиодному устройству.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET (чтение)	Импорт сведений об управлении экраном устройства из базы данных. В случае отсутствия сведений об управлении, запрос на их получение отправляется в устройство.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT (заполнение)	Отправка отредактированной информации об управлении экраном на устройство. Сведения об экране, отправленные в виде протокола, будут содержать только отредактированные значения.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET (чтение)	Получение отредактированной информации об управлении экраном из устройства. Выполнение этого запроса API возможно после завершения запроса updateDisplayInfo API.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET (чтение)	Импорт общих сведений об устройстве из базы данных. Общие сведения устройства обновляются при его подключении к серверу.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT (заполнение)	Отправка отредактированной информации на устройство. Общие сведения об устройстве, отправленные в виде протокола, будут содержать только отредактированные значения.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET (чтение)	Получение отредактированной информации об устройстве. Выполнение этого запроса API возможно после завершения запроса updateGeneralInfo API.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT (заполнение)	Перемещение устройства в другую группу.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET (чтение)	Отправка протокола запуска RM на устройство. С устройства, на которое принят стартовый протокол RM, периодически отправляются сведения через сервер дистанционного управления.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET (чтение)	Отправка протокола остановки RM на устройство. Устройство незамедлительно останавливает выполнение соответствующей функции при получении протокола с остановкой.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET (чтение)	Импорт параметров устройства. Параметры устройства обновляются при его подключении к серверу.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT (заполнение)	Отправка измененных параметров на устройство. Настройки, отправленные в виде протокола, будут содержать только отредактированные значения.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET (чтение)	Получение измененных параметров от устройство. Выполнение этого запроса API возможно после завершения запроса updateSetupInfo API.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET (чтение)	Отправка запроса текущей информации об управлении экраном на устройство. При вызове этого API запрос отображается в виде ответного значения.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET (чтение)	Импорт информации об управлении экраном, отправленной с устройства. Эта опция используется для выполнения двух действий: отправка запроса информации на устройство и получение информации о нем.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET (чтение)	Отправка запроса информации о текущем времени на устройство. При вызове этого API запрос отображается в виде ответного значения.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET (чтение)	Импорт информации о времени экраном, отправленной с устройства. Эта опция используется для выполнения двух действий: отправка запроса информации на устройство и получение информации о нем.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET (чтение)	Импорт информации о времени устройства из базы данных. В случае отсутствия сведений об управлении, запрос на их получение отправляется в устройство.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT (заполнение)	Отправка отредактированной информации о времени на устройство. Сведения об времени, отправленные в виде протокола, будут содержать только отредактированные значения.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET (чтение)	Получение отредактированной информации о времени от устройства. Выполнение этого запроса API возможно после завершения запроса getUpdatedTimeInfoResult API.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET (чтение)	Импорт списка организаций.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET (чтение)	Импорт подробных сведений о {groupId} группе.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET (чтение)	Импорт информации о подгруппах ниже {groupId}.

Пользователь

Добавляйте пользователей и управляйте информацией о них. Службы для работы с пользователями доступны для авторизованных пользователей, обладающих правами на чтение, запись и управление информацией о пользователях.

Ниже приведены доступные службы управления пользователями:

Название услуги	Вызов API	Тип вызова	Описание
createUser	/restapi/v1.0/ums/users	POST (создание)	Добавление пользователя.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET (чтение)	Импорт необходимых сведений о пользователях с панели управления.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT (заполнение)	Редактирование сведений о пользователях.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET (чтение)	Импорт списка организаций. Данная опция используется для настройки дерева групп.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET (чтение)	Импорт списка организаций.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET (чтение)	Импорт подробных сведений о {groupId} группе.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET (чтение)	Импорт списка подгрупп под указанной {groupId} группой.

Настройка

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

Название услуги	Вызов API	Тип вызова	Описание
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET (чтение)	Импорт списка категорий.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE (удалить)	Удаление определенной информации о панели управления.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET (чтение)	Импорт содержимого, отображаемого на пользовательской панели управления. Можно настраивать отображение только указанной информации на панели управления.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT (заполнение)	Изменение порядка отображения объектов на панели управления.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET (чтение)	Активация резервной панели управления.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET (чтение)	Импорт учетных данных, отображаемых на панели управления.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET (чтение)	Импорт информации с доски объявлений, отображаемой на панели управления.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE (удалить)	Удаление публикации из доски объявлений.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET (чтение)	Импорт подробных сведений о выбранной публикации.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST (создание)	Размещение публикаций на доске объявлений.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT (заполнение)	Изменение выбранной публикации на доске объявлений.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET (чтение)	Импорт информации об объеме памяти, отображаемой на панели управления.
listLicense	/restapi/v1.0/ems/license	GET (чтение)	Импорт списка лицензий, зарегистрированных на сервере.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET (чтение)	Импорт параметров сервера. Элементы настройки сервера включают опции, с помощью которых включаются или отключаются различные функции на сервере.
getTagListInfo	/restapi/v1.0/ems/tag	POST (создание)	Импорт списка меток, зарегистрированных на сервере.

Открытие подробных сведений API (swagger UI)

http://184.169.167.38:7001/MagicInfo/swagger-ui.html

Content

Space Tools

Page History

Versions Compared

Old Version 86

New Version 87

Key

Autenticação

OPEN API (v2.0)

Conteúdo

Lista de reprodução

Programar

Dispositivo

Utilizador

Definição

Detalhes da Open API (IU swagger)

Проверка подлинности

OPEN API (v2.0)

Содержимое

Плейлист

Расписание

Устройство

Пользователь

Настройка

Открытие подробных сведений API (swagger UI)