Configuration du serveur
Using standard HTTP requests, the 4D REST Server allows external applications to access the data of your application directly, i.e. to retrieve information about the dataclasses in your project, manipulate data, log into your web application, and much more.
Pour commencer à utiliser les fonctionnalités REST, vous devez démarrer et configurer le serveur 4D REST.
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.
Controlling REST access
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.
You can configure REST accesses with one of the following means:
- (recommended) enable the force login mode and create an
authentify()datastore class function to authenticate users and assign privileges to their web session (see User login modes). - assign a Read/Write user group to REST services in the "Web > Web Features" page of the Structure Settings;
- write an
On REST Authenticationdatabase method to intercept and handle every initial REST request.
- It is recommended not to enable different REST access control features simultaneously to avoid conflicts.
- If an
On REST Authenticationdatabase method has been defined, any setting made using the "Read/Write" menu on the Web > Web Features page of the Structure Settings is ignored.
Utilisation des Paramètres de la Structure
The Read/Write menu in the "Web > Web Features" page of the structure settings specifies a group of 4D users that is authorized to establish the link to the 4D application using REST queries.
By default, the menu displays \<Anyone>, which means that REST accesses are open to all users. 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.
For more information, refer to the On REST Authentication database method documentation.
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.
Uncheck the Expose as REST resource option:
Do this for each table whose exposure needs to be modified.
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.
Repeat this for each field whose exposure needs to be modified.
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.
Mode préemptif
On 4D Server, REST requests are automatically handled through preemptive processes, even in interpreted mode. You need to make sure that your code is compliant with a preemptive execution.
To debug interpreted web code on the server machine, make sure the debugger is attached to the server or to a remote machine. Les process Web passent alors en mode coopératif et le code du serveur Web peut être débogué.
Avec 4D monoposte, le code interprété s'exécute toujours en mode coopératif.