Documentation :
Comment interroger les webservices depuis vos programmes, avec des exemples prêts à l’emploi.
Vérifier les mises à jour en PureBasic :
Le fichier ci-dessous se place à côté de votre source et s’inclut avec XIncludeFile "koakdesign_api.pbi".
La procédure KD_VerifierMiseAJour() appelle le webservice version et remplit une structure :
il suffit ensuite de tester Maj\MiseAJour. Lancé seul, le fichier exécute l’exemple du bas.
; ==========================================================
; KoakDesign - vérifier les mises à jour d'un logiciel
; Webservice : ?page=api&data=version (réponse JSON)
; PureBasic 6.x - aucune bibliothèque externe
; (avant PureBasic 6.00, appeler InitNetwork() une fois au démarrage)
; ==========================================================
EnableExplicit
#KD_API = "https://koakdesign.info/?page=api&data=version"
Structure KD_MiseAJour
Ok.i ; #True si le site a répondu sans erreur
MiseAJour.i ; #True si une version plus récente existe
Version.s ; dernière version publiée
Date.s ; AAAA-MM-JJ
Notes.s ; nouveautés, une par ligne
Telecharger.s ; adresse de téléchargement
Page.s ; fiche du logiciel sur le site
Message.s ; explication en cas d'erreur
EndStructure
; Lit un champ texte sans planter s'il est absent ou null
Procedure.s KD_Texte(*Objet, Champ.s)
Protected *Valeur = GetJSONMember(*Objet, Champ)
If *Valeur And JSONType(*Valeur) = #PB_JSON_String
ProcedureReturn GetJSONString(*Valeur)
EndIf
ProcedureReturn ""
EndProcedure
; Lit un champ vrai / faux (#False s'il est absent)
Procedure.i KD_Booleen(*Objet, Champ.s)
Protected *Valeur = GetJSONMember(*Objet, Champ)
If *Valeur And JSONType(*Valeur) = #PB_JSON_Boolean
ProcedureReturn GetJSONBoolean(*Valeur)
EndIf
ProcedureReturn #False
EndProcedure
; Interroge le site. Renvoie #True si la réponse est valide (voir *Resultat\MiseAJour)
Procedure.i KD_VerifierMiseAJour(Logiciel.s, VersionInstallee.s, *Resultat.KD_MiseAJour)
Protected Url.s, *Reponse, Json.i, *Racine
ClearStructure(*Resultat, KD_MiseAJour)
Url = #KD_API + "&args_0=" + URLEncoder(Logiciel) + "&v=" + URLEncoder(VersionInstallee)
*Reponse = ReceiveHTTPMemory(Url)
If *Reponse = 0
*Resultat\Message = "Pas de réponse du site (pas de connexion ?)"
ProcedureReturn #False
EndIf
Json = CatchJSON(#PB_Any, *Reponse, MemorySize(*Reponse))
FreeMemory(*Reponse)
If Json = 0
*Resultat\Message = "Réponse illisible"
ProcedureReturn #False
EndIf
*Racine = JSONValue(Json)
If JSONType(*Racine) = #PB_JSON_Object
*Resultat\Ok = KD_Booleen(*Racine, "ok")
*Resultat\MiseAJour = KD_Booleen(*Racine, "mise_a_jour")
*Resultat\Version = KD_Texte(*Racine, "version")
*Resultat\Date = KD_Texte(*Racine, "date")
*Resultat\Notes = KD_Texte(*Racine, "notes")
*Resultat\Telecharger = KD_Texte(*Racine, "telecharger")
*Resultat\Page = KD_Texte(*Racine, "page")
*Resultat\Message = KD_Texte(*Racine, "message")
EndIf
FreeJSON(Json)
ProcedureReturn *Resultat\Ok
EndProcedure
; ---------------------------------------------------------
; Exemple : au démarrage du logiciel
; ---------------------------------------------------------
CompilerIf #PB_Compiler_IsMainFile
Define Maj.KD_MiseAJour
If KD_VerifierMiseAJour("pocket-printer", "1.0.0", @Maj)
If Maj\MiseAJour
If MessageRequester("Mise à jour disponible", "La version " + Maj\Version + " est disponible :" + #LF$ + #LF$ + Maj\Notes + #LF$ + #LF$ + "Ouvrir la page de téléchargement ?", #PB_MessageRequester_YesNo | #PB_MessageRequester_Info) = #PB_MessageRequester_Yes
RunProgram(Maj\Page)
EndIf
Else
Debug "Logiciel à jour (dernière version : " + Maj\Version + ")"
EndIf
Else
Debug "Vérification impossible : " + Maj\Message
EndIf
CompilerEndIf
Avec d’autres langages :
C# (.NET 6 et plus, System.Net.Http et System.Text.Json) :
using var http = new HttpClient();
var json = await http.GetStringAsync("https://koakdesign.info/?page=api&data=version&args_0=pocket-printer&v=1.0.0");
using var doc = JsonDocument.Parse(json);
var r = doc.RootElement;
if (r.GetProperty("ok").GetBoolean() && r.GetProperty("mise_a_jour").GetBoolean())
Console.WriteLine("Nouvelle version : " + r.GetProperty("version").GetString());
PowerShell :
$r = Invoke-RestMethod "https://koakdesign.info/?page=api&data=version&args_0=pocket-printer&v=1.0.0"
if ($r.mise_a_jour) { "Nouvelle version : " + $r.version }
Ou simplement dans un navigateur : ?page=api&data=version&args_0=pocket-printer&v=1.0.0
Bonnes pratiques :
- Vérifiez les mises à jour une fois au démarrage, ou une fois par jour : la réponse est de toute façon gardée 5 minutes en cache.
- Faites l’appel sans bloquer l’interface (dans un thread, ou après l’ouverture de la fenêtre) : sans réseau,
ReceiveHTTPMemory()peut attendre plusieurs secondes. - Une erreur réseau ne doit jamais empêcher le logiciel de démarrer : ignorez-la simplement.
- Laissez l’utilisateur décider : proposez d’ouvrir la page du logiciel plutôt que de télécharger automatiquement.
- Le nom du logiciel à envoyer est celui de son adresse sur le site :
?page=software&data=view&args_0=supernova.
Modules :
La référence des modules PureBasic publiés sur le site (fonctions, paramètres, exemples) arrive ici prochainement. En attendant, les sources et leurs explications sont dans la rubrique Développement.
