Icon

Partager Envoyer

(Document)

Services WEB fournis à travers l'API RESTful

Des services web basiques pour votre application sont fournis via l'API RESTful intégrée.

Ces services permettent d'interagir avec les comptes d'utilisateurs, les collections et les contenus enregistrés dans la base de données. L'API peut fournir des réponses aux formats HTML, XML ou JSON (ce dernier est le format par défaut).

Une méthode log permet également d'enregistrer des événements système via l'API (avec POST).
 

Contrôle d'accès

Par défaut, l'API supporte le contrôle d'accès avec des clés de 40 caractères.
Chaque clé unique doit être générée et liée à un compte d'utiilsateur (via le champ id_user) dans la table _rest_api_keys.

Une clé valide doit être transmise à chaque appel de l'API via un en-tête HTTP X-AUTH-KEY.
Les accès à l'API sont enregistrés dans la table.
 

Documentation

La documentation complète des services web se trouve ici.

Vous pouvez vérifier que la génération de clés fonctionne dans le Tableau de bord de l'application (Gérer » Application) à la rubrique Tests unitaires (menu gauche). Il est également possible d'y tester le bon fonctionnement de l'API.

Vous pouvez enfin créer et ajouter vos propres méthodes dans le fichier contrôleur de l'API : controllers/api/REST.php.

 


Ce document a été publié le 2018-12-09 08:05:36. (Dernière mise à jour : 2019-01-10 07:39:55.)




This website uses 'cookies' to enhance user experience and provide authentification. You may change which cookies are set at any time by clicking on more info. Accept
x