Configuration du serveur
À l'aide de requêtes HTTP standard, le serveur 4D REST permet aux applications externes d'accéder directement aux données de votre application, c'est-à-dire de récupérer des informations sur les dataclass de votre projet, de manipuler des données, de vous connecter à votre application Web et bien plus encore.
Pour commencer à utiliser les fonctionnalités REST, vous devez démarrer et configurer le serveur 4D REST.
- Sur 4D Server, l'ouverture d'une session REST nécessite une licence client 4D disponible.
- On 4D single-user, you can open up to three REST sessions for testing purposes.
- You need to manage the session for your requesting application.
Démarrage du serveur REST
Pour des raisons de sécurité, par défaut, 4D ne répond pas aux requêtes REST. Si vous souhaitez démarrer le serveur REST, cochez l'option Exposer en tant que serveur REST dans la page Web > Web Features des paramètres de la structure afin que les requêtes REST soient traitées.
Les services REST utilisent le serveur HTTP 4D; vous devez donc vous assurer que le serveur web 4D est lancé.
Le message d'avertissement "Attention, vérifiez les privilèges d'accès" s'affiche lorsque vous cochez cette option, pour attirer votre attention sur le fait que lorsque les services REST sont activés, l'accès par défaut aux objets de base de données est gratuit tant que les accès REST n'ont pas été configurés.
You must restart the 4D application for your changes to take effect.
Configuration de l'accès REST
Par défaut, les accès REST sont ouverts à tous les utilisateurs, ce qui n'est évidemment pas recommandé pour des raisons de sécurité et de contrôle de l'utilisation des licences clientes.
Vous pouvez configurer les accès REST de l'une des manières suivantes :
- en attribuant un groupe d'utilisateurs en lecture/écriture aux services REST dans la page "Web > Web Features" des paramètres de structure ;
- saisir d'une méthode base
On REST Authenticationpour intercepter et gérer chaque demande REST initiale.
Vous ne pouvez pas utiliser les deux fonctionnalités simultanément. Une fois qu'une méthode base
On REST Authenticationa été définie, 4D lui donne entièrement le contrôle des requêtes REST : tout paramètre effectué à l'aide du menu "Lecture/Ecriture" de la page de Web > Fonctionnalités Web des paramètres de la structure est ignoré.
Utilisation des Paramètres de la Structure
Le menu Lecture/Écriture de la page "Web > Web Features" des paramètres de la structure indique un groupe d'utilisateurs 4D autorisé à établir le lien vers l'application 4D à l'aide des requêtes REST.
Par défaut, le menu affiche <Anyone>, ce qui signifie que les accès REST sont ouverts à tous les utilisateurs. Une fois que vous avez spécifié un groupe, seul un compte utilisateur 4D appartenant à ce groupe peut être utilisé pour accéder à 4D via une requête REST. Si un compte utilisé n'appartient pas à ce groupe, 4D renvoie une erreur d'authentification à l'expéditeur de la requête.
Pour que ce paramètre prenne effet, la méthode base
On REST Authenticationne doit pas être définie. S'il existe, 4D ignore les paramètres d'accès définis dans les propriétés de la structure.
Méthode base On REST Authentication
La méthode base On REST Authentication vous permet de contrôler de manière personnalisée l’ouverture des sessions REST sur 4D. Cette méthode base est automatiquement appelée lorsqu'une nouvelle session est ouverte à l'aide d'une requête REST. Lorsqu'une requête d’ouverture de session REST est reçue, les identifiants de connexion sont fournis dans l’en-tête de la requête. La méthode base On REST Authentication est appelée afin de vous permettre d’évaluer ces identifiants. Pour obtenir plus d'informations, veuillez vous reporter à la documentation de la méthode base On REST Authentication. Pour obtenir plus d'informations, veuillez vous reporter à la documentation de la méthode base On REST Authentication.
Exposer les tables et les champs
Une fois les services REST sont activés dans l'application 4D, une session REST peut par défaut accéder à toutes les tables et à tous les champs de la base de données 4D via l'interface du datastore. Ainsi, elle peut utiliser leurs données. Par exemple, si votre base de données contient une table [Employee], il est possible d'écrire :
http://127.0.0.1:8044/rest/Employee/?$filter="salary>10000"
Cette requête retournera tous les employés dont le champ "salary" est supérieur à 10 000.
Les tables et/ou champs 4D dont l'attribut est "invisible" sont également exposés par défaut dans REST.
Si vous souhaitez personnaliser les objets du datastore accessibles via REST, vous devez désactiver l'exposition de chaque table et/ou champ que vous souhaitez masquer. Lorsqu'une requête REST tente d'accéder à une ressource non autorisée, 4D retourne une erreur.
Exposer des tables
Par défaut, toutes les tables sont exposées dans REST.
Pour des raisons de sécurité, vous pouvez choisir d'exposer uniquement certaines tables du datastore aux appels REST. Par exemple, si vous avez créé une table [Users] stockant les noms d'utilisateur et les mots de passe, il serait préférable de ne pas l'exposer.
Pour supprimer l'exposition REST d'une table :
Affichez l'Inspecteur de table dans l'Editeur de structure et sélectionnez la table à modifier.
Décochez l'option Exposer en tant que ressource REST :
Procédez ainsi pour chaque table dont l'exposition doit être modifiée.
Exposer des champs
Par défaut, touts les champs d'une base 4D sont exposés dans REST.
Vous pouvez choisir d'exposer certains champs de vos tables à REST. Par exemple, si vous ne souhaitez pas exposer le champ [Employees]Salary.
Pour supprimer l'exposition REST d'un champ :
Affichez l'Inspecteur de champ dans l'Editeur de structure et sélectionnez le champ à modifier.
Décochez la case Exposer en tant que ressource REST pour le champ.
Répétez cette opération pour chaque champ dont l'exposition doit être modifiée.
Pour qu'un champ soit accessible via REST, la table parente doit l'être également. Si la table parente n'est pas exposée, aucun de ses champs ne le sera, quel que soit leur statut.