Webservices

Documentation Swagger

Vous pouvez accéder à la documentation swagger de YellowBox via le menu de paramétrage puis en déroulant le sous menu “Maintenance” puis en cliquant sur “Maintenance” qui ouvre les outils de Maintenance.
Le lien “Documentation swagger” vous permet d’accéder à la documentation des Web Services.

Accès à la documentation Swagger

Structure de la base YellowBox

Pour utiliser les web services, il faut connaître la structure de la base. Pour y accéder, il faut se rendre dans le menu de paramétrage, dérouler le menu “Ecrans et strutcture”, cliquer sur “Structure”, cliquer dans le bandeau jaune sur “Boite à outils” puis sur “Structure de la base”. Un nouvel onglet s’ouvre avec la représentation de la base de données.

Accès à la structure de la base

Exemples

Tous les exemples présentés dans cette documentation seront réalisés à l’aide de l’application Postman, disponible en téléchargement à l’adresse suivante : Postman.

Dans la section Authentification nous verrons qu’il est également possible de tester chaque web service directement depuis Swagger.