API / XML PHP
Pour rappel l’index des Blu-ray défectueux a été porté dans deux types de fichier XML (c’est ce format qui a été retenu afin d’effectuer des recherches) et JSON
Pour le contenu qui va suivre, est acquis le fait que l’utilisateur connait la structuration de l’index XML. |
Articles en relation :
- Portage index vers XML et JSON
- Notice EAN/UPC concernant les index XML-JSON
- Exploitation fichier XML, recherche à l’aide des codes-barres
Pour le moment des connexions externes directes à une base de données dédiée que nous pourrions héberger ne sont pas autorisées par notre solution d’hébergement (principalement pour des raisons de sécurité) c’est pourquoi la solution des fichiers XML/JSON a été mise en place.
L’Objectif à terme est de construire une véritable API simple et performante.
Recherche sur les EAN/UPC uniquement
recherche sur la totalité ou partie d’un EAN/UPC
Interrogation du fichier XML depuis une requête, dans l’URL (intégration distante possible) après le paramètre ‘q=’ (query) :
> https://bluraydefectueux.com/ressources/api/rechercheeanxml.php?q=
Le fichier a été mis à jour le 24/02/24 : une opération de vérification et d'éviction des doublons (à cause des balises EAN-UPC-X) dans les résultats a été ajoutée.
Source du fichier : https://bluraydefectueux.com/ressources/api/rechercheeanxml.php
Mise en application/intégration dans une page HTML à l’interface simple et efficace avec mef des résultats :
> https://bluraydefectueux.com/ressources/api/rechercheean.html
Présentation (dans ses grandes lignes) du mécanisme :
Par analogie avec l’automobile, l’UI c’est la carrosserie, l’intérieur : les commandes etc… le fichier PHP le moteur et le fichier XML le carburant.
L’utilisateur peut développer son UI HTML (sur un modèle identique à la nôtre par exemple) comme il le souhaite. Le seul impératif est de respecter le protocole HTTPS (appel fichiers, requêtes) de bout en bout.
Recherche sur différents éléments :
Remplace l’ancien fichier ‘recherche-xml-an.php » (basé uniquement sur les titres et les codes-barres).
<TITRE> | <EDITEUR> | <PRESSEUR> | <MOULD> |
<TYPE> | <CAPACITE> | <ANNEE> | <PROVENANCE> |
<EAN-UPC> | <EAN-UPC-1> | <EAN-UPC-2> | <EAN-UPC-3> |
Ajout d’une nouvelle balise (en vue de l’indexation des BD UHD/4K) : <TYPE>.
Syntaxes employées :
- <MOULD> : ‘IFPI (suivi de 4 caractères)’
- <TYPE> : ‘BD’, ‘BD3D’, ‘BDPA’ ou ‘UHD-4K’
- <CAPACITE>: ‘BD25’, ‘BD50’, ‘UHD100’ ou ‘UHD66’
- <PROVENANCE> : ‘France’ ou ‘Benelux’
- <EAN-UPC-X> : 13 ou 12 chiffres
Ajout d’une balise unique en tête de fichier (XML et JSON) : <VERSION> qui indique la version du fichier, date d’indexation + nombre de révisions.
La recherche partielle est possible, l’insensibilité à la casse également mais nécessite de respecter les lettres accentuées (notamment pour les titres).
Interrogation du fichier XML depuis une requête, dans l’URL (intégration distante possible) après le paramètre ‘q=’ (query):
> https://bluraydefectueux.com/ressources/api/recherche-xml-comp.php?q=
Le fichier a été mis à jour le 24/02/24 : une opération de vérification et d'éviction des doublons (à cause des balises EAN-UPC-X) dans les résultats a été ajoutée. A été également ajouté un paramètre optionnel supplémentaire de recherche '&element=' ciblant celle-ci sur certaines balises XML et ceci afin d’affiner certains résultats (pour éviter certaines confusions avec certains termes qui pourraient être présents dans la balise TITRE). Exemple : 'https://bluraydefectueux.com/ressources/api/recherche-xml-comp?q=bd3d&element=type' va afficher tous les Blu-ray répertoriés comme étant 3D, sachant que si cette mention apparait dans certains titres et pas dans le type, ils ne seront pas pris en compte. Ainsi, 'element' peut prendre comme valeur (insensible à la casse) : TITRE, EDITEUR, PRESSEUR, MOULD, TYPE, CAPACITE, ANNEE, PROVENANCE, EAN-UPC, EAN-UPC-1, EAN-UPC-2 ou EAN-UPC-3
Source du fichier : https://bluraydefectueux.com/ressources/api/recherche-xml-comp.php
Ciblage sur certains éléments
Une nouvelle UI (V2) permettant de cibler sa recherche sur certains éléments de l’index XML a été développée.
Elle comprend une mise à jour de l’historique de recherche, le surlignement dans les résultat l’élément cible (si il a été sélectionné dans le menu déroulant) ainsi qu’un affichage du temps de traitement.
> https://bluraydefectueux.com/ressources/api/recherchecomp.html
Cette page sera complétée ou modifiée au gré des avancées.
Date de dernière édition/révision : 30/03/2024