4

API Rest

afornerot edited this page 2020-09-30 17:09:18 +02:00

Table of Contents

• rest/login
• rest/user/{login}
• rest/users
• rest/groups
• rest/bookmark/add
• rest/bookmark/del
• rest/alert/hide

rest/login

• Permet de tester l'accès à ninegate
• key = parametre obligatoire
• key = clé d'accès de l'api

rest/user/{login}

• Récupération des informations utilisateurs issus du masteridentity
• key = parametre obligatoire
• key = clé d'accès de l'api
• only = paramétre optionnel
• only = liste des informations désirés = user, items, bookmarks, groups, alerts, calendars

rest/users

• Liste l'ensemble des utilisateurs de ninegate et retourne ses attributs
• key = parametre obligatoire
• key = clé d'accès de l'api

rest/groups

• Liste l'ensemble des groupes de ninegate et retourne ses attributs ainsi que les membres des groupes en question
• key = parametre obligatoire
• key = clé d'accès de l'api

rest/bookmark/add

• Ajout d'un item ninegate existant comme bookmark d'un utilisateur
• key = parametre obligatoire
• key = clé d'accès de l'api
• login = parametre obligatoire
• login = uid de l'utilisateur sur lequel on souhaite ajouter un bookmark
• iditem = parametre obligatoire
• iditem = id de l'item ninegate qui doit etre ajouté en tant que bookmark

rest/bookmark/del

• Suppression d'un bookmark
• key = parametre obligatoire
• key = clé d'accès de l'api
• idbookmark = parametre obligatoire
• idbookmark = id du bookmark à supprimer

rest/alert/hide

• Cache une alert à un utilisateur
• key = parametre obligatoire
• key = clé d'accès de l'api
• login = parametre obligatoire
• login = uid de l'utilisateur sur lequel on souhaite masquer une alerte
• idalert = parametre obligatoire
• idalert = id de l'alert à cacher