Page History

Versions Compared

Old Version 97

changes.mady.by.user user-f347e

Saved on Aug 03, 2018

compared with

New Version 98

changes.mady.by.user user-f347e

Saved on Aug 03, 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 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 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 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

...

Content

Space Tools