Aller au contenu principal

Commandes

Informations générales

Il est possible d'intervenir sur la base de données à travers quelques requêtes HTTP.

Requête

Les paramètres doivent être passés en tant que paramètre GET ou POST. Nous recommandons d'exécuter ces commandes par une requête HTTP POST.

Point de terminaison: https://gateway-sandbox.rhyzom.dev/

Réponse

Toutes les réponses sont retournées au format JSON avec les champs code et message au minimum.

Nettoyage des données

Cette commande supprime toutes les détections datant de plus de 15 minutes d'une session définie.

attention

Si la session est de type ADMIN, la commande impactera toutes les sessions.

Requête

ChampValeurDescription
apiclearNom de la commande
sessionNom de la sessionNom de la session
passwordMot de passeMot de passe

Réponse

En cas de réussite:

ChampValeurDescription
code0Commande exécutée correctement
messageNettoyage effectuéeNettoyage effectuée
countNombre de détections impactéesNombre de détections impactées

En cas d'échec:

ChampValeurDescription
codeCode erreurCode erreur
messageDescription erreurDescription de l'erreur

Purge des données

Cette commande supprime toutes les détections d'une session définie.

attention

Si la session est de type ADMIN, la commande impactera toutes les sessions.

Requête

ChampValeurDescription
apiresetNom de la commande
sessionNom de la sessionNom de la session
passwordMot de passeMot de passe

Réponse

En cas de réussite:

ChampValeurDescription
code0Commande exécutée correctement
messageNettoyage effectuéeNettoyage effectuée
countNombre de détections impactéesNombre de détections impactées

En cas d'échec:

ChampValeurDescription
codeCode erreurCode erreur
messageDescription erreurDescription de l'erreur