API HTTP Rest

i-Tego WM — 2020-11-03T14:48:04Z

zQR-Codes expose une API HTTP Rest.

Accéder à l'API

L'accès à l'API est limité au cadre d'un abonnement donné. L'abonnement doit être valide.

L'accès à l'API nécessite donc de fournir dans la requête les identifiants de l'utilisateur (login et password utilisés pour la connexion à l'application zQR-Codes avec i-Tego SaaS).

Exemple :

https://login:password@qrc.dnc.global/api/json/qrcodes

Opérations permises par l'API

L'API permet à un utilisateur d'effectuer les opérations CRUD sur la table des QR-Codes en fonction de la méthode de la requête HTTP GET, POST, PUT ou DELETE :

Formats

Dans l'état actuel du développement, l'API de O-DGuide n'expose que le format suivant :

Format json
Retourne un simple array. Exemple : la requête :

https://qrc.dnc.global/api/json/qrcode/1

retourne :

Types

Dans l'état actuel du développement, l'API de O-DGuide n'expose que le type 'qrcode'.

Actions

Suivant le paradigme HTTP Rest, les actions découlent de la méthode HTTP utilisée pour appeler l'API : get, post, put ou delete.

Formes générales des requêtes
Une requête GET prend la forme :
https://qrc.dnc.global/api/[path_parameters] | [?request_parameters]

– path_parameters : /[/ressource]
généralement ce sera : json/qrcode, NN indiquant l'ID d'un QR-Code précis.

– query_parameters : dans le cas de GET, il s'agit des classiques paramètres d'URL, tels que "url_cible=https://mon_site.com/blabla.php".

Exemple de requêtes GET
– Afficher la liste des QR-Codes disponibles pour l'auteur authentifié :

https://qrc.dnc.global/api/json/qrcode

– Accès à une ressource précise :

https://qrc.dnc.global/api/json/qrcode/33

où 33 est l'ID de ressource, en l'occurrence la valeur du champ id_qrcode de l'enregistrement dans la table.

Requêtes avec POST, PUT et DELETE

Ces requêtes doivent être générées programmatiquement : par exemple avec cURL côté serveur ou en Javascript côté client. On trouve couramment des bibliothèque exposant des fonctions de ce type :

– post_collection($requete, $reponse)
Créer une nouvelle ressource dans la collection (créer un nouvel enregistrement dans la table).

– put_ressource($requete, $reponse)
Ce cas est sensiblement le même que le précédent, à ceci près que l'on travaille sur la modification d'une ressource précise.

– delete_ressource($requete, $reponse)
Supprimer définitivement une ressource.

Pour la transmission des données aux requêtes avec POST et PUT, on applique le format application/json. Dans l'exemple qui suit, on passe deux tableaux PHP, la fonction se chargeant de l'encodage JSON et de la déclaration. On passe les paramètres de la façon suivante :

$path_parameters = "json/qrcode";
$query_parameters = array(
'id_auteur' => '1', // SPIP administrator
'titre' => $titre,
'url_cible' => $url_cible,
'statut' => 'publie'
);

Télécharger

et voici la fonction :

function http_request( $apiurl, $method, $path_parameters=null, $query_parameters=null ) {
$url = $apiurl . $path_parameters;
$h = curl_init($url);
if ( !empty($query_parameters) )
curl_setopt($h, CURLOPT_POSTFIELDS, json_encode($query_parameters));
if ( $method == "POST" ) {
$header[] = "content-type: application/json";
} else if ( $method !== "GET" ) {
curl_setopt($h, CURLOPT_CUSTOMREQUEST, $method);
}
curl_setopt($h, CURLOPT_FOLLOWLOCATION, true);
curl_setopt($h, CURLOPT_RETURNTRANSFER, true);
curl_setopt($h, CURLOPT_TIMEOUT, 10);
curl_setopt($h, CURLOPT_HTTPHEADER, $header);
$result = curl_exec($h);
curl_close($h);
return $result;
}

Télécharger

Présentation de zQR-Codes

2020-10-15T13:56:15Z

Avec zQR-Codes créez vos propres matrices QR et modifiez à volonté la page cible.

Les QR codes générés de façon classique

Différents outils disponibles sur le Web permettent de créer un QR-code traduisant directement l'URL de la page à visiter. Une telle façon de faire, liant définitivement le QR code à une page et une seule, présente des inconvénients majeurs, par exemple dans les situations suivantes :

– Vous avez composé une carte professionnelle ou une plaquette publicitaire avec un QR code branchant sur la page d'accueil de votre site Internet. Que faites-vous si vous changez le nom de domaine de votre site ? Si, participant à une exposition, vous voulez faire la promotion de votre stand ? Si, lançant un nouveau produit vous voulez brancher directement vos visiteurs sur la page de ce produit ?

– Vous avez publié à grand frais un catalogue de vos produits. Vous avez placé dans différentes pages des QR codes permettant à vos clients de se connecter sur votre site Internet pour en savoir plus. Vos produits évoluent, un nouveau produit arrive : continuerez-vous de connecter vos clients sur l'ancien produit et les laisserez-vous dans l'ignorance du nouveau produit ?

Les QR codes indexés

DnC propose sa technique d'indexation des QR-codes. Dans ce contexte, les données d'un QR-code sont réduites au nom de domaine du site support et à un index, par exemple :

https://qrc.dnc.global/3

Le site support reçoit cette URL et la traduit à l'aide d'une base de données comportant, à la valeur de l'index, une URL cible. Le visiteur qui flashe le QR-Code est immédiatement redirigé vers cette URL (s'il s'agit d'une page Web, mais ce peut être la commande d'un objet connecté, etc.).

Le site support fournit tous les outils nécessaires pour gérer cette URL, en particulier pour en modifier l'adresse à tout moment.

De plus, la base de données du site support contient les entrées suivantes pour chaque code :
– un titre,
– une description,
– des statistiques de l'utilisation de chaque QR-Code.

permettant des usages avancés tels que :

– affichage d'un message particulier ;
– affichage de plusieurs bandeaux offrant au visiteur le choix de la page cible ;
– publicité préalable à la redirection sous forme de bannière ou de vidéo ;
– affichage d'un questionnaire,
– audio-guide,
– etc.

Notes :

– Utilisez les QR codes dans le respect de la réglementation et des bons usages !

– Un autre avantage des QR codes indexés est leur moindre densité (l'URL est plus courte), permettant une lecture de plus loin qu'un QR code classique de même dimension.