API - REST

[JFMALBI]

Nous utilisons GRR dans notre collectivité depuis plusieurs années et il répond au besoin et les utilisateurs l'ont adopté sans soucis.
Nous souhaiterions le coupler avec une solution de Digital Signage (Xibo en l’occurrence qui dispose d'une API pour intégrer des données externes).
Existe-t-il une API (type REST) afin de récupérer les réservations d'une ressource (ou des ressources)?
L'idée est ensuite de pouvoir l'afficher ces données à travers l'application XIBO et la mise en page adaptée (sur écran central ou écran au niveau des salles de réunion)

[ynaessens]

Bonjour,
il n'y a pas d'API dans GRR actuellement.
Pour ce que vous envisagez, une solution d'échange au format JSON devrait convenir, n'est-ce pas ?
Il faudrait alors définir le format de données attendu et les paramètres utiles pour créer un fichier JSON que XIBO pourrait ensuite transformer en affichage pour les écrans.
Si un autre format est attendu, la question est à étudier.
Cordialement,
YN

[JFMALBI]

Oui du format JSON correspondrait tout à fait au besoin. La question était de savoir si une API existait car la solution XIBO est capable de faire des appels GET directement. Nous allons donc devoir faire un bout de code intermédiaire qui requête sur le GRR et expose une API REST pour le XIBO.

[ynaessens]

Bonjour,
pour écrire la requête et la mettre en forme pour XIBO, il faut connaître ce qui est attendu.
Ce serait bien de finaliser en collaboration, ce qui pourrait s'adapter à d'autres solutions d'affichage. Et une première contribution à la naissance d'une API...
Cordialement,
YN

[JFMALBI]

Je vois 2 besoins à ce stade
1/ Lecture des réservations : GET avec en paramètre date_début, date_fin, domaine, ressource (optionnel, sinon toutes les ressources du domaine). Pour simplifier, ce serait l'idéal que les paramètres domaine et ressource soient du texte
Retour JSON attendu: cf fichier_joint : API_GRR_GET
2/ Création d'une réservation (moins urgent que le 1/) : PUT avec le même type de fichier JSON en entrée. Je suppose que cela nécessitera de fourni des id (domaine, ressource etc ...) si c'est trop complexe de travailler avec les libellés des domaines, ressources et type
Envoi JSON : cf fichier_joint : API_GRR_PUT
Il faudra donc que l'on puisse récupérer les éléments via d'autres requêtes GET . A ce stade je vois :

• récupération des domaines avec en retour id_domaine et libelle_domaine
• récupération des ressources pour 1 domaine avec en retour id_ressource et libelle_ressource
• récupération des types de réservation (id_type et [libelle_type)
  API_GRR_GET.ods
  API_GRR_PUT.ods

A votre disposition pour échanger !

[ynaessens]

Bonjour,
commençons par api_grr_get : quelle serait la requête envoyée par XIBO ?
Quelque chose tel que : GRR/outils/grr2xibo.php?debut=date_de_debut&fin=date_de_fin&ressource=id_room ?
Avec en retour un objet JSON contenant les valeurs indiquées dans votre fichier API_GRR_GET.ods ?

[JFMALBI]

Oui je suis d'accord démarrons par le 1er besoin !
Oui la requête pourrait être celle que vous proposez. Dans un premier temps nous pourrions "coder en dur" l'id_room dans les requêtes venant du XIBO afin de valider au moins le principe.

[ynaessens]

Voici un fichier grr2xibo.txt à renommer en grr2xibo.php, à déposer dans le répertoire chemin_vers_grr/outils/
Il devrait rendre un objet JSON, dont les paramètres sont en dur, pour valider la réception des données par le XIBO.
L'appel devrait donc être chemin_vers_grr/outils/grr2xibo.php, voir ce que XIBO en fait...

[JFMALBI]

Super ! Quelle réactivité :-)
On va le déployer et faire des essais. Je vous tiens bien sur au courant de l'avancé
Merci encore

[JFMALBI]

Je vous confirme que cela fonctionne !
J'arrive bien à récupérer les éléments JSON sur le XIBO

[ynaessens]

Bonjour,
voici un premier jet avec une requête et un export JSON selon les paramètres passés au script.
Cordialement,
YN
grr2xibo.txt

[JFMALBI]

Merci ! Je vais tester et vous fait un retour semaine prochaine

[JFMALBI]

Bonjour,
Je viens de tester le nouveau script. Cela ne fonctionne pas, mais j'ai essayé de "debugger". Ci-après les éléments

1/ include "../include/connect.inc.php"; modifié en include "../include/personnalisation/connect.inc.php";

2/ Je pense qu'il y a une erreur dans la requête (au niveau des > et <) :
$req = "SELECT area_name, room_name, r.description as rd, name, e.description as ed FROM
(".TABLE_PREFIX."_entry e JOIN ".TABLE_PREFIX."_room r ON r.id = e.room_id) JOIN ".TABLE_PREFIX."_area a ON a.id = r.area_id
WHERE (e.start_time < ? AND e.end_time > ? AND e.room_id = ?)
LIMIT 1";
modifié en :
$req = "SELECT area_name, room_name, r.description as rd, name, e.description as ed FROM
(".TABLE_PREFIX."_entry e JOIN ".TABLE_PREFIX."_room r ON r.id = e.room_id) JOIN ".TABLE_PREFIX."_area a ON a.id = r.area_id
WHERE (e.start_time > ? AND e.end_time < ? AND e.room_id = ?)
LIMIT 1";

Par contre je n'obtiens aucun résultat

Quand j'exécute la requête "en dure" dans mysql,: OK, j'ai bien des résultats
SELECT area_name, room_name, r.description as rd, name, e.description as ed FROM (grr_entry e JOIN grr_room r ON r.id = e.room_id) JOIN grr_area a ON a.id = r.area_id WHERE (e.start_time > 946724400 AND e.end_time < 1893495600 AND e.room_id = 1) LIMIT 1;

Par contre via le script je n'obtiens rien ...
Je me suis dis que cela pouvait venir de l'ordre des paramètres. Mais je n'obtiens toujours rien
$res = grr_sql_query($req,"iii",[$end_time,$start_time,$ressource_id]);
transformé en
$res = grr_sql_query($req,"iii",[$start_time,$end_time,$ressource_id]);

J'ai ensuite essayé de coder "en dur" la requête (idem à celle faite directement dans mysql), mais là encore je n'obtiens rien
$req = "SELECT area_name, room_name, r.description as rd, name, e.description as ed FROM (grr_entry e JOIN grr_room r ON r.id = e.room_id) JOIN grr_area a ON a.id = r.area_id WHERE (e.start_time > 946724400 AND e.end_time < 1893495600 AND e.room_id = 1) LIMIT 1";

$res = grr_sql_query($req);

La function grr_sql_query est-elle suffisante (fait-elle la connexion à la BD, et le commit ?) .... je n'ai pas plus explorer ce point
Avez-vous une idée ?

[JFMALBI]

Contrairement à ce que j'ai indiqué, en codant en dur la requête cela fonctionne, mais pas avec les paramètres :
$res = grr_sql_query($req,"iii",[$start_time,$end_time,$ressource_id]);
Autre point (toujours en restant que la requête en "dur", si je mets une LIMIT 10, je n'ai toujours qu'un seul enregistrement en sortie dans le JSON

[JFMALBI]

Donc pour résumer : ce qui fonctionne (mais avec toujours un seul enregistrement en sortie, même quand je mets un LIMIT 10):

$req = "SELECT area_name, room_name, r.description as rd, name, e.description as ed FROM (grr_entry e JOIN grr_room r ON r.id = e.room_id) JOIN grr_area a ON a.id = r.area_id WHERE (e.start_time > $start_time AND e.end_time < $end_time AND e.room_id = $ressource_id) LIMIT 1";

$res = grr_sql_query($req);

En espérant ne pas avoir été trop brouillon dans mes explications

[JFMALBI]

J'ai modifié le code pour répondre à nos besoins.
Je vous le mets en pièce jointe pour voir si cela pourrait convenir ?
grr2xibov2.txt

Cdlt

[ynaessens]

Bonjour,
je regroupe mes remarques suite à vos contributions.
Je n'avais pas tenu compte du fait que vous étiez en version 4 et avais utilisé les requêtes préparées que la version 3.5.2 prend en compte, mais pas encore les versions 4... ce qui explique que vos requêtes restaient sans réponse.
Le second point sur lequel j'avais un doute est la capacité de XIBO de prendre en compte des réponses multiples : votre modification suggère que oui. Est-ce utile de distinguer le cas où il y a une réponse du cas où il y en a plusieurs ?
Enfin le calcul des bornes de la recherche dépend de votre usage. La version initiale sélectionne toutes les réservations qui chevauchent l'intervalle choisi alors que la v2 ne sélectionne que les réservations incluses dans l'intervalle choisi. À vous de voir si c'est plus pertinent, ce n'était pas mon choix.
Je vous propose une nouvelle version évitant la fonction grr_sql_row qui devrait fonctionner.
Cordialement,
YN
grr2xibov3.txt

[JFMALBI]

Concernant le nombre d'enregistrements en retour, effectivement Xibo est en capacité d'en récupérer plusieurs. Cela pourrait être un paramètre à passer (par défaut 1) afin de rendre plus générique ce début d'API.
Je viens de tester votre nouvelle version, cela fonctionne parfaitement !

[JFMALBI]

On pourrait aussi avoir un paramètre pour le format de la date en sortie dans le JSON (par défaut en français "d/m/Y", mais pouvoir spécifier le format via un nouveau paramètre)

[ynaessens]

Pourquoi pas. J'en reste à l'essentiel, en proposant une version qui s'adapte aux deux familles de GRR, récupérables par git.
Merci pour votre patience et votre aide.

[JFMALBI]

Merci à vous surtout !