Page History

Versions Compared

Old Version 85

changes.mady.by.user user-f347e

Saved on Aug 02, 2018

compared with

New Version 86

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	fr

MagicINFO Server vous permet de mettre en place une gestion du contenu, une gestion des programmes, une gestion des périphériques et d’autres fonctions en appelant Open API (v2.0).

Pour utiliser Open API (v2.0), vous devez d’abord effectuer un processus d’authentification. Utilisez une page Swagger distincte pour tester chaque API.

Authentification

Lorsque vous appelez tous les éléments Open API (v2.0), vous devez inclure api_token dans l’en-tête. Si ceci n’est pas inclus, une erreur « 401 Unauthorized » est renvoyée.

Un jeton obtenu expire et devient inutilisable après une durée définie. Si tel est le cas, vous devez obtenir un nouveau jeton.

Il est possible d’obtenir api_token en appelant l’API suivante.

Nom du service	Requête API	Type de requête	Description
authenticationRequest	/auth	POST	Importe une valeur de jeton pour l’authentification à l’aide de l’identifiant d’utilisateur et du mot de passe.
authenticationRequest	/auth/refresh	GET	Crée un nouveau jeton pour étendre le délai d’expiration. Il est possible d’appeler REST API sans se reconnecter

OPEN API (v2.0)

MagicINFO Server Open API (v2.0) fournit diverses fonctions. La configuration de chaque fonction est indiquée ci-dessous.

Catégorie	Contrôleur	Description
Contenu :	content-controller	Gestion du contenu
Contenu :	content-group-controller	Gestion du groupe de contenu
Liste de lecture	playlist-controller	Gestion des listes de lecture
Liste de lecture	playlist-group-controller	Gestion du groupe de listes de lecture
Programme	content-schedule-controller	Gestion du programme de contenu
	content-schedule-group-controller	Gestion du groupe de programmes de contenu
	message-schedule-controller	Gestion des programmes de messages
	message-schedule-group-controller	Gestion du groupe de programmes de message
Périphérique	device-controller	Gestion des périphériques
Périphérique	device-group-controller	Gestion du groupe de périphériques
Utilisateur	user-controller	Gestion des utilisateurs
Utilisateur	user-group-controller	Gestion du groupe d’utilisateurs
Réglage	environment-controller	Réglage

Contenu :

Téléchargez, approuvez ou supprimez du contenu. Gérez des listes de contenu. Les services relatifs au contenu sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer du contenu.

Les services disponibles de gestion de contenu sont comme suit :

Nom du service	Requête API	Type de requête	Description
listAllContent	/restapi/v1.0/cms/contents	GET	Permet d’importer une liste du contenu téléchargé. La liste inclut les vignettes de contenu, les noms, les types de fichiers et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
listDashboardContentInfo	/restapi/v1.0/cms/contents/dashboard	GET	Permet d’importer des informations de contenu générales à afficher sur le tableau de bord.
listContent	/restapi/v1.0/cms/contents/filter	POST	Permet d’importer une liste de contenu filtré selon des conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
forceDeleteContent	/restapi/v1.0/cms/contents/force/{contentId}	DELETE	Supprime du contenu, que le contenu soit inclus ou non dans une liste de lecture ou un programme.
deleteContent	/restapi/v1.0/cms/contents/{contentId}	DELETE	Supprime du contenu après avoir vérifié que le contenu n’est pas inclus dans une liste de lecture ou un programme. Si vous tentez de supprimer du contenu inclus dans une liste de lecture ou un programme, le contenu n’est pas supprimé et un code d’erreur est renvoyé.
getActiveContentInfo	/restapi/v1.0/cms/contents/{contentId}	GET	Permet d’importer les détails d’une version activée du contenu. La version du contenu est mise à jour à chaque fois que le contenu est modifié.
approveContents	/restapi/v1.0/cms/contents/{contentId}/approval	PUT	Permet d’approuver/de rejeter du contenu. Le contenu approuvé est déplacé dans la liste de contenu général et peut être utilisé dans des listes de lecture ou des programmes.
uploadContent	/restapi/v1.0/cms/contents/{groupId}	POST	Permet de télécharger du nouveau contenu.
listDefaultGroup	/restapi/v1.0/cms/contents/groups	GET	Permet d’importer une liste des groupes de contenu par défaut.
getGroup	/restapi/v1.0/cms/contents/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listChildGroup	/restapi/v1.0/cms/contents/groups/{groupId}/child	GET	Permet d’importer une liste de sous-groupes dans le groupe {groupId}.

Liste de lecture

Utilisez du contenu pour créer, modifier ou supprimer des listes de lecture. Les services relatifs aux listes de lecture sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer du contenu.

Les services disponibles de gestion de liste de lecture sont comme suit :

Nom du service	Requête API	Type de requête	Description
listAllPlaylist	/restapi/v1.0/cms/playlists	GET	Permet d’importer une liste de toutes les listes de lecture. La liste inclut les noms des listes de lecture, les vignettes de contenu principales, les types de listes de lecture et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
createPlaylist	/restapi/v1.0/cms/playlists	POST	Crée une nouvelle liste de lecture.
getDashboardPlaylistInfo	/restapi/v1.0/cms/playlists/dashboard	GET	Permet d’importer depuis le tableau de bord des informations de liste de lecture indispensables.
listPlaylist	/restapi/v1.0/cms/playlists/filter	POST	Permet d’importer une liste des listes de lecture filtrées selon des conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
deletePlaylist	/restapi/v1.0/cms/playlists/{playlistId}	DELETE	Supprime la liste de lecture sélectionnée. Si vous tentez de supprimer une liste de lecture incluse dans un programme, la liste de lecture n’est pas supprimée et un code d’erreur est renvoyé.
getActivePlaylistInfo	/restapi/v1.0/cms/playlists/{playlistId}	GET	Permet d’importer les détails d’une version activée d’une liste de lecture. La version d’une liste de lecture est mise à jour à chaque fois que cette liste de lecture est modifiée.
editPlaylist	/restapi/v1.0/cms/playlists/{playlistId}	PUT	Modifie la liste de lecture {playlistId}. La modification d’une liste de lecture actualise la version de cette liste de lecture. Ainsi, le périphérique lisant la liste de lecture lit automatiquement la version mise à jour.
copyPlaylist	/restapi/v1.0/cms/playlists/{playlistId}/copy	PUT	Copie la liste de lecture {playlistId}. Un duplicata de la liste de lecture est créé.
listDefaultGroup	/restapi/v1.0/cms/playlists/groups	GET	Permet d’importer une liste des groupes de listes de lecture par défaut.
getGroup	/restapi/v1.0/cms/playlists/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listChildGroup	/restapi/v1.0/cms/playlists/groups/{groupId}/child	GET	Permet d’importer une liste de sous-groupes dans le groupe {groupId}.

Programme

Créez de nouveaux programmes de contenu ou de message. Publiez des programmes sur des périphériques pour la lecture. Modifiez ou supprimez des programmes.

Les services relatifs aux programmes sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer des programmes.

Les services disponibles de gestion de programme sont comme suit :

Nom du service	Requête API	Type de requête	Description
listContentScheduleAll	/restapi/v1.0/dms/schedule/contents	GET	Permet d’importer une liste de tous les programmes de contenu. La liste inclut les noms des programmes de contenu, les dates de création, les types de périphériques et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
createContentSchedule	/restapi/v1.0/dms/schedule/contents	POST	Permet de créer un nouveau programme de contenu. Un programme de contenu peut contenir plusieurs canaux et cadres. Publiez un programme sur des périphériques et lisez le contenu souhaité ou la liste de lecture à un moment spécifié.
listDashboardScheduleInfo	/restapi/v1.0/dms/schedule/contents/dashboard	GET	Permet d’importer depuis le tableau de bord des informations de programme de contenu indispensables.
listContentScheduleByGroup	/restapi/v1.0/dms/schedule/contents/filter	POST	Permet d’importer une liste de programmes de contenu filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
deleteContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	DELETE	Supprime un programme de contenu. En cas de suppression d’un programme précédemment publié sur un périphérique, le périphérique lit automatiquement le contenu par défaut.
getProgramInfo	/restapi/v1.0/dms/schedule/contents/{programId}	GET	Permet d’importer les détails du programme sélectionné.
editContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}	PUT	Permet de modifier un programme de contenu. En cas de modification d’un programme précédemment publié sur un périphérique, le périphérique lit automatiquement le programme modifié.
copyContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/copy	PUT	Permet de copier le programme de contenu {programId}. Un duplicata du programme de contenu {programId} est créé.
deployContentSchedule	/restapi/v1.0/dms/schedule/contents/{programId}/deploy	PUT	Permet de publier un programme de contenu sur un groupe de périphériques spécifique.
getPublishStatus	/restapi/v1.0/dms/schedule/contents/{programId}/publishStatus	GET	Permet d’importer le statut de téléchargement en temps réel d’un programme de contenu depuis un périphérique.
getRootGroups	/restapi/v1.0/dms/schedule/contents/groups	GET	Permet d’importer une liste de tous les groupes de racine pour un programme de contenu.
listContentScheduleGroupInfo	/restapi/v1.0/dms/schedule/contents/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listAllMessageSchedule	/restapi/v1.0/dms/schedule/messages	GET	Permet d’importer une liste de tous les programmes de message.
createMessageSchedule	/restapi/v1.0/dms/schedule/messages	POST	Permet de créer un nouveau programme de message.
listMessage	/restapi/v1.0/dms/schedule/messages/filter	POST	Permet d’importer une liste de programmes de message filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
deleteMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	DELETE	Supprime le programme de message sélectionné. En cas de suppression d’un programme de message précédemment publié sur un périphérique, la modification est appliquée automatiquement au périphérique.
getMessageInfo	/restapi/v1.0/dms/schedule/messages/{messageId}	GET	Permet d’importer les détails du programme de message sélectionné.
editMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}	PUT	Permet d’éditer le programme de message sélectionné. En cas de modification d’un programme de message précédemment publié sur un périphérique, la modification est appliquée automatiquement au périphérique.
copyMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/copy	PUT	Permet de copier le programme de message sélectionné. Un duplicata du programme de message est créé.
deployMessageSchedule	/restapi/v1.0/dms/schedule/messages/{messageId}/deploy	PUT	Permet de publier le programme de message sélectionné sur un groupe de périphériques.
getRootGroups	/restapi/v1.0/dms/schedule/messages/groups	GET	Permet d’importer une liste de tous les groupes de racine pour un programme de contenu.
listMessageScheduleGroupInfo	/restapi/v1.0/dms/schedule/messages/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
getChildGroups	/restapi/v1.0/dms/schedule/messages/groups/{groupId}/child	GET	Permet d’importer une liste de sous-groupes dans un groupe spécifique.

Périphérique

Contrôlez et gérez les périphériques. Les services relatifs aux périphériques sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer des périphériques.

Les services disponibles de gestion de périphérique sont comme suit :

Nom du service	Requête API	Type de requête	Description
listAllDevice	/restapi/v1.0/rms/devices	GET	Permet d’importer une liste de tous les périphériques. La liste inclut l’état d’alimentation du périphérique, les informations de vignette, le statut d’erreur du périphérique et d’autres informations de base. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
getDashboardDeviceInfo	/restapi/v1.0/rms/devices/dashboard	GET	Permet d’importer depuis le tableau de bord des informations de périphérique indispensables.
filterDeviceList	/restapi/v1.0/rms/devices/filter	POST	Permet d’importer une liste de périphériques filtrés selon différentes conditions. Vous pouvez importer les listes par page à l’aide d’informations de recherche.
deleteDevice	/restapi/v1.0/rms/devices/{deviceId}	DELETE	Supprime le périphérique sélectionné.
getDevice	/restapi/v1.0/rms/devices/{deviceId}	GET	Permet d’importer les détails du périphérique sélectionné.
approveDevice	/restapi/v1.0/rms/devices/{deviceId}/approval	PUT	Permet d’approuver le périphérique sélectionné sur un groupe spécifique.
getCabinetList	/restapi/v1.0/rms/devices/{deviceId}/cabinet	POST	Permet d’importer des informations sur les cabinets connectés à un périphérique LED. Les informations importées sont valides uniquement lorsque les cabinets sont connectés à un périphérique LED.
updateCabinetInfo	/restapi/v1.0/rms/devices/{deviceId}/cabinet	PUT	Permet de modifier des informations sur les cabinets connectés à un périphérique LED.
getDisplayControlInfo	/restapi/v1.0/rms/devices/{deviceId}/display	GET	Permet d’importer des informations de contrôle d’affichage du périphérique depuis la base de données. S’il n’y a pas d’informations de contrôle, une requête d’informations doit être envoyée au périphérique.
updateDisplayInfo	/restapi/v1.0/rms/devices/{deviceId}/display	PUT	Permet d’envoyer sur un périphérique des informations de contrôle d’affichage modifiées. Seules les valeurs modifiées dans les informations d’affichage sont envoyées au périphérique en tant que protocole.
getUpdatedDisplayInfoResult	/restapi/v1.0/rms/devices/{deviceId}/display/{requestId}	GET	Permet de recevoir depuis un périphérique des informations de contrôle d’affichage modifiées. Cette API peut être exécutée après l’exécution de l’API updateDisplayInfo.
getGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general	GET	Permet d’importer des informations de périphérique générales depuis la base de données. Les informations de périphérique générales sont actualisées lorsque le périphérique se connecte au serveur.
updateGeneralInfo	/restapi/v1.0/rms/devices/{deviceId}/general/info	PUT	Permet d’envoyer sur un périphérique des informations de périphérique modifiées. Seules les valeurs modifiées dans les informations de périphérique de base sont envoyées au périphérique en tant que protocole.
getUpdatedGeneralInfoResult	/restapi/v1.0/rms/devices/{deviceId}/general/{requestId}	GET	Permet de recevoir depuis un périphérique des informations de périphérique modifiées. Cette API peut être exécutée après l’exécution de l’API updateGeneralInfo.
moveDevice	/restapi/v1.0/rms/devices/{deviceId}/move	PUT	Permet de déplacer un périphérique sur un autre groupe.
startRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/start	GET	Permet d’envoyer sur un périphérique un protocole de démarrage RM. Un périphérique ayant reçu un protocole de démarrage RM envoie régulièrement des informations via le serveur de la télécommande.
stopRmServerVnc	/restapi/v1.0/rms/devices/{deviceId}/rmserver/stop	GET	Permet d’envoyer sur un périphérique un protocole d’arrêt RM. Un périphérique ayant reçu un protocole d’arrêt arrête immédiatement la fonction correspondante.
getSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	GET	Permet d’importer des paramètres relatifs à un périphérique. Les paramètres de périphérique sont actualisés lorsque le périphérique se connecte au serveur.
updateSetupInfo	/restapi/v1.0/rms/devices/{deviceId}/setup	PUT	Permet d’envoyer sur un périphérique des paramètres de périphérique modifiés. Seules les valeurs modifiées dans les paramètres sont envoyées au périphérique en tant que protocole.
getUpdatedSetupInfoResult	/restapi/v1.0/rms/devices/{deviceId}/setup/{requestId}	GET	Permet de recevoir depuis un périphérique des paramètres de périphérique modifiés. Cette API peut être exécutée après l’exécution de l’API updateSetupInfo.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display	GET	Permet d’envoyer sur un périphérique une requête d’informations actuelles de contrôle d’affichage. Si vous appelez cette API, vous recevez requestId comme valeur de réponse.
getCurrentStatusDisplay	/restapi/v1.0/rms/devices/{deviceId}/status/display/{requestId}	GET	Permet d’importer depuis un périphérique des informations de contrôle d’affichage. Cette option est utilisée pour deux actions : envoyer une requête d’informations à un périphérique et recevoir des informations actuelles sur le périphérique.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time	GET	Permet d’envoyer sur un périphérique une requête d’informations actuelles concernant l’heure. Si vous appelez cette API, vous recevez requestId comme valeur de réponse.
getCurrentStatusTime	/restapi/v1.0/rms/devices/{deviceId}/status/time/{requestId}	GET	Permet d’importer des informations sur l’heure envoyées depuis un périphérique. Cette option est utilisée pour deux actions : envoyer une requête d’informations à un périphérique et recevoir des informations actuelles sur le périphérique.
getTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	GET	Permet d’importer des informations sur l’heure du périphérique depuis la base de données. S’il n’y a pas d’informations de contrôle, une requête d’informations doit être envoyée au périphérique.
updateTimeInfo	/restapi/v1.0/rms/devices/{deviceId}/time	PUT	Permet d’envoyer sur un périphérique des informations modifiées concernant l’heure. Seules les valeurs modifiées dans les informations sur l’heure sont envoyées au périphérique en tant que protocole.
getUpdatedTimeInfoResult	/restapi/v1.0/rms/devices/{deviceId}/time/{requestId}	GET	Permet de recevoir depuis un périphérique des informations modifiées sur l’heure du périphérique. Cette API peut être exécutée après l’exécution de l’API getUpdatedTimeInfoResult.
listDeviceGroupOrgan	/restapi/v1.0/rms/devices/groups	GET	Permet d’importer une liste d’organisations.
listDeviceGroupInfo	/restapi/v1.0/rms/devices/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listDeviceGroupChild	/restapi/v1.0/rms/devices/groups/{groupId}/child	GET	Permet d’importer des informations de sous-groupes dans {groupId}.

Utilisateur

Ajoutez des utilisateurs et gérez les informations d’utilisateur. Les services relatifs aux utilisateurs sont accessibles pour les utilisateurs authentifiés possédant les privilèges nécessaires pour lire, écrire et gérer les informations d’utilisateur.

Les services disponibles de gestion d’utilisateur sont comme suit :

Nom du service	Requête API	Type de requête	Description
createUser	/restapi/v1.0/ums/users	POST	Permet d’ajouter un utilisateur.
listDashboardUserInfo	/restapi/v1.0/ums/users/dashboard	GET	Permet d’importer depuis le tableau de bord des informations d’utilisateur indispensables.
updateMyInfo	/restapi/v1.0/ums/users/me	PUT	Permet de modifier les informations relatives à l’utilisateur.
listUserOrgan	/restapi/v1.0/ums/users/organization	GET	Permet d’importer une liste d’organisations. Cette option peut être utilisée pour configurer une arborescence de groupes.
listUserGroupOrgan	/restapi/v1.0/ums/users/groups	GET	Permet d’importer une liste d’organisations.
listUserGroupInfo	/restapi/v1.0/ums/users/groups/{groupId}	GET	Permet d’importer les détails du groupe {groupId}.
listUserGroupChild	/restapi/v1.0/ums/users/groups/{groupId}/child	GET	Permet d’importer une liste de sous-groupes dans le groupe {groupId}.

Réglage

En plus des fonctions principales, vous pouvez utiliser de nombreuses autres fonctions pour créer et gérer des tags et des catégories, et modifier le tableau de bord.

Nom du service	Requête API	Type de requête	Description
getCategoryInfo	/restapi/v1.0/ems/category/{categoryId}	GET	Permet d’importer une liste de catégories.
deleteDashboard	/restapi/v1.0/ems/dashboard	DELETE	Permet de supprimer des informations de tableau de bord spécifiques.
listDashboardInfo	/restapi/v1.0/ems/dashboard	GET	Permet d’importer du contenu à afficher sur le tableau de bord personnalisé. Vous ne pouvez afficher que des informations spécifiques sur le tableau de bord.
updateDashboardPriority	/restapi/v1.0/ems/dashboard	PUT	Permet de changer l’ordre des éléments affichés sur le tableau de bord.
createDashboard	/restapi/v1.0/ems/dashboard/create	GET	Permet d’activer un tableau de bord inactif.
listDashboardLoginInfo	/restapi/v1.0/ems/dashboard/login	GET	Permet d’importer des informations de connexion à afficher sur le tableau de bord.
listDashboardNoticeInfo	/restapi/v1.0/ems/dashboard/notice	GET	Permet d’importer des informations de tableau d’affichage à afficher sur le tableau de bord.
deleteNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	DELETE	Permet de supprimer une publication du tableau d’affichage.
listEditNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	GET	Permet d’importer les détails de la publication sélectionnée.
createNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	POST	Permet d’ajouter des publications au tableau d’affichage.
updateNoticeInfo	/restapi/v1.0/ems/dashboard/notice/edit	PUT	Permet de modifier la publication sélectionnée sur le tableau d’affichage.
listDashboardStorageInfo	/restapi/v1.0/ems/dashboard/storage	GET	Permet d’importer des informations de stockage à afficher sur le tableau de bord.
listLicense	/restapi/v1.0/ems/license	GET	Permet d’importer une liste de licences enregistrées sur le serveur.
getServerSetupInfo	/restapi/v1.0/ems/setup	GET	Permet d’importer des paramètres relatifs au serveur. Les éléments de réglage du serveur incluent des options qui peuvent activer ou désactiver différentes fonctions sur le serveur.
getTagListInfo	/restapi/v1.0/ems/tag	POST	Permet d’importer une liste de tags enregistrés sur le serveur.

Détails sur Open API (interface utilisateur Swagger)

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

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

Content

Space Tools

Page History

Versions Compared

Old Version 85

New Version 86

Key

Authentification

OPEN API (v2.0)

Contenu :

Liste de lecture

Programme

Périphérique

Utilisateur

Réglage

Détails sur Open API (interface utilisateur Swagger)

Autenticação

OPEN API (v2.0)

Conteúdo

Lista de reprodução

Programar

Dispositivo

Utilizador

Definição

Detalhes da Open API (IU swagger)