Services RPC (server)
(→Authentification) |
(→Format d'URL) |
||
| Ligne 43 : | Ligne 43 : | ||
L’appelant doit exécuter une commande HTTP / GET sur l’URL du service. | L’appelant doit exécuter une commande HTTP / GET sur l’URL du service. | ||
La réponse d’un service REST est un flux XML ou JSON dont la structure et le contenu varie suivant le service. | La réponse d’un service REST est un flux XML ou JSON dont la structure et le contenu varie suivant le service. | ||
| + | |||
| + | ===Aiguillage des requêtes=== | ||
| + | Lorsque le champ X-Rpc-Method n'est pas spécifié, le chemin de l'url est interprété pour déterminer la méthode : | ||
| + | |||
| + | {|class="wikitable" | ||
| + | |- | ||
| + | !url action | ||
| + | !X-Rpc-Method | ||
| + | |- | ||
| + | |login.l1000 | ||
| + | |design.login | ||
| + | |- | ||
| + | |action.l1000 | ||
| + | |design.action | ||
| + | |- | ||
| + | |rpc.l1000 | ||
| + | | | ||
| + | |- | ||
| + | |portal.l1000 | ||
| + | |url.portal | ||
| + | |- | ||
| + | |connect.l1000 | ||
| + | |url.connect | ||
| + | |- | ||
| + | |rss.l1000 | ||
| + | |rss.<url fragment> | ||
| + | |- | ||
| + | |sdata.l1000 | ||
| + | |sdatajson.execute | ||
| + | |- | ||
| + | |sdata | ||
| + | |sdatajson.execute | ||
| + | |} | ||
===Authentification=== | ===Authentification=== | ||
Version du 9 octobre 2013 à 07:41
Sommaire |
Introduction
Le serveur Ligne 1000 contient un service REST qui permet d’accéder aux différents services techniques du serveur. Sa fonction première est d’offrir un accès à travers HTTP aux services techniques 1000 et de permettre ainsi une utilisation plus large de ces services.
Le serveur REST 1000 interprète une URI, exécute le service REST concerné et retourne le résultat en XML.
Format d'URL
Les points d’accès aux services REST sont des URL définies à partir de la racine de l’URL du serveur Web. L’URL d’un service REST est définie ainsi :
GET url: http://host/service/server/rpc.l1000?parameters Headers: X-Rpc-Method=service.action Accept: application/xml application/json
| HostName | Nom DNS de la machine Serveur |
| ServiceName | Nom du service Ligne 1000 sur la machine |
| X-Rpc-Method | Champ spécifique de l'entête de requête contenant la méthode à exécuter |
| Accept | Type de contenu accepté |
| Paramètres de l’action. | Couples « paramètre=valeur » |
L’appelant doit exécuter une commande HTTP / GET sur l’URL du service. La réponse d’un service REST est un flux XML ou JSON dont la structure et le contenu varie suivant le service.
Aiguillage des requêtes
Lorsque le champ X-Rpc-Method n'est pas spécifié, le chemin de l'url est interprété pour déterminer la méthode :
| url action | X-Rpc-Method |
|---|---|
| login.l1000 | design.login |
| action.l1000 | design.action |
| rpc.l1000 | |
| portal.l1000 | url.portal |
| connect.l1000 | url.connect |
| rss.l1000 | rss.<url fragment> |
| sdata.l1000 | sdatajson.execute |
| sdata | sdatajson.execute |
Authentification
Il existe différent modes d'authentification suivant l'usage du service :
| Mode | Usage |
|---|---|
| Aucun | Le service ne requière pas d’authentification. |
| Anonyme | Le service requière une authentification, si celle-ci n’est pas fournie dans les paramètres de l’appel une session anonyme, rattachée à l’utilisateur du serveur, sera créée. |
| Authentifié | Le service requière une authentification passée en paramètre. L’identifiant de session doit être passé dans un paramètre SID de l'URL ou bien à travers les cookies de session. |
Service de session
Le service RPC de session permet de gérer les sessions de l'utilisateur.
| Nom | Action | Authentification | Usage |
|---|---|---|---|
| info | session | Non | Vérification de session |
| info | login | non | Ouverture de session |
| info | logout | non | Fermeture de session |
| info | configuration | non | Informations de configuration |
| info | usergroups | non | Retourne les groupes d'un utilisateur pour un dossier |
| info | getcontext | oui | Retourne les informations sur le contexte utilisateur |
| info | setcontext | oui | Modifie le contexte utilisateur |
| info | themes | non | Informations sur les thèmes |
