Api

Documentation

L’URL suivant donne accès aux détails des fonctions disponibles avec l’url suivant http://<host:port>/api/help/index

Sécurité

L’Api utilise un système d’authentification basé sur un token décrit dans la rfc6750.

1. Le client doit demander un token en appelant le service /api/oauth/token
   Le corps du message doit être de type « application/x-www-form-urlencoded »
   Il doit contenir les champs

   1. « grant_type » avec la valeur « password »

   2. « username » avec le nom de l’utilisateur

   3. « password » avec le mot de passe associé

2. Lors de l’appel à tout autres méthodes le token doit être renvoyé dans l’entête du message sous la forme
   Authorization: Bearer "token"

3. Le token à un délai d’expiration défini dans la configuration de l’API.
   Une fois ce temps écoulé il est nécessaire de demander un nouveau token.

Odata

La version 2 de l’Api est basée sur la norme Odata OData - the Best Way to REST
On trouve une documentation restreinte ici : OData Cheat Sheet: Query Options/Filter Expressions & SQL Analogues (skyvia.com)

Création de nouveaux enregistrements

La creation de nouvelles données se fait avec un méthode “POST”.

L’api contrôle que les données soumises sont cohérentes. Dans le cas contraire une erreur est renvoyée et la donnée n’est pas créée.

Les champs peuvent être obligatoire ou optionnel.

Pour certains champs optionnels une valeur par défaut est utilisée.

Les tableaux suivant liste chaque champ en spécifiant s'il est optionnel et si une valeur par défaut est appliquée.

Symbole de la colonnes “obligatoire”

• Le champs est obligatoire

• Le champs prend une valeur par défaut s'il n’est pas défini.

• Le champs ne peut pas être défini.