HttpsGet(< URL > [, < Option > : < Valeur >] [, < Option > : < Valeur >] …)
Fait une requête GET en utilisant le protocole https, retourne le résultat de la requête.
Elle permet de :
Les options s'écrivent après l'URL, sous la forme Option : Valeur, séparées par des virgules. Le nom d'une option s'écrit avec ou sans guillemets, et sa casse et ses accents n'ont pas d'importance. Les noms entre parenthèses sont des alias. Une option peut être répétée quand c'est précisé.
Paramètres de la requête :
En-têtes :
Authentification :
Retour :
OAuth2 :
Comportement de la requête :
HttpsGet( "www.monip.org" )
Retourne le texte de la réponse de la page.
HttpsGet( "maps.googleapis.com/maps/api/geocode/json"
, Param : "key="+['Clé Api Google' de 'Paramètres généraux' <1FFIF8A79H>]
, Param : "address="+RemplaceAccent( ['Adresse à envoyer' de 'Web Service coordonnées' <14DMF89OKA>] )
)
Appelle l'API de géocodage avec deux paramètres de requête, sans avoir à les encoder.
HttpsGet( ['URL' de 'Signature Yousign' <172L4S5M9E>]+"/signature_requests/"+['Id Signature Request' de 'Signature Yousign' <16UPP3EVGP>]
, Auth : "Bearer"
, ApiToken : Col( ['Clé API' de 'Paramètres Yousign' <16H0RRLI4J>], ['Paramètres Yousign' de 'Signature Yousign' <1C3SS69DUU>] )
)
Appelle une API en envoyant un jeton dans l'en-tête Authorization Bearer.
HttpsGet( "api.insee.fr/entreprises/sirene/V3.11/siren/"+Gauche( Remplace( <%Siren%>, " ", "" ), 9 )
, BearerToken : <%APIKey%>
)
Appelle l'API avec un jeton Bearer. Équivalent plus court de l'exemple précédent : BearerToken force l'authentification Bearer.
HttpsGet( "api.exemple.fr/export"
, Identifiant : "mon_login"
, MotDePasse : "mon_mot_de_passe"
)
Appelle une API avec une authentification par identifiant et mot de passe (basic par défaut).
HttpsGet( "api.exemple.fr/v1/clients"
, Entête : "Accept:application/json"
, Entête : "Accept-Language:fr"
)
Ajoute deux en-têtes à la requête.
HttpsGet( "eu.api.ovh.com/1.0/"+<%API%>
, Horodatage : HttpsGet( "eu.api.ovh.com/1.0/auth/time" )
, Entête : "X-Ovh-Application:"+<%ApplicationKey%>
, Entête : "X-Ovh-Consumer:"+<%ConsumerKey%>
, Entête_Nom : "X-Ovh-Timestamp"
, Entête_Valeur : <% Horodatage %>
, Entête_Nom : "X-Ovh-Signature"
, Entête_Valeur : "$1$"+HachageValeur( "sha1", <%ApplicationSecret%>+"+"+<%ConsumerKey%>+"+"+<% Méthode %>+"+"+<% URL %>+"+"+ChangeCharset( <% Corps %>, "ANSI", "UTF8" )+"+"+<% Horodatage %>, "hexamin" )
)
Signe la requête : l'horodatage est celui du serveur de l'API, et l'en-tête de signature est construit après l'URL et le corps de la requête grâce à Entête_Valeur.
HttpsGet( "www.googleapis.com/calendar/v3/calendars/primary/events"
, ClientId : "229031535445-xxxxxxxxxxxxxxxxxxxxxxx.apps.googleusercontent.com"
, ClientSecret : "xxxxxxx"
, OAuth2_Scope : "https://www.googleapis.com/auth/calendar.events"
)
Appelle l'API avec une authentification OAuth2.
HttpsGet( "api.exemple.fr/v1/commandes"
, TraiteRetour : ConstruitJSON( "code" : <% Code %>, "body" : <% Corps %> )
)
Retourne un JSON contenant le code de retour HTTP et le corps de la réponse.
HttpsGet( "api.laposte.fr/suivi/v2/idships/"+['Réf transporteur' de 'Bon de livraison' <15VKUK1HGP>]
, Header : "X-Okapi-Key: "+['LaPoste Clé API' de 'Paramètres logistiques' <1F53E2NU40>]
, Header : "Accept: application/json"
, TraiteRetour : MajValeurJSON( ""
, ""
, Tableau( Tableau( "code", ValeurJSON( <% Code %>, "returnCode" ) )
, Tableau( "body", ValeurJSON( <% Corps %>, "shipment/event[0]" ) )
)
, 1 )
)
Appelle l'API de suivi de La Poste, avec la clé d'API dans l'en-tête X-Okapi-Key, et retourne un JSON à deux clés : code et body.
HttpsGet( "api.insee.fr/api-sirene/3.11/siren/"+SiNonVide( Gauche( Remplace( ['N° de Siret' de 'Société' <16P5BEJI2G>], " ", "" ), 9 )
, Gauche( Remplace( ['N° Siret' de 'Société' <1APH34P8FE>], " ", "" ), 9 ) )
, "Header" : ( "X-INSEE-Api-Key-Integration: "+['Clé API SIREN' de 'Paramètres généraux' <1028KOG0MH>] )
)
Appelle l'API Sirene de l'INSEE avec les 9 premiers caractères du numéro de Siret de la société (lu dans l'une ou l'autre des deux colonnes, espaces retirés), la clé d'API étant envoyée dans l'en-tête X-INSEE-Api-Key-Integration. Les noms d'options peuvent être écrits entre guillemets, et leur valeur entre parenthèses.
<%Params%> := SI( <%Limit%><>Nul, Tableau( "limit", <%Limit%> ) )
HttpsGet( "api.openai.com/v1/batches"
, Params : <%Params%>
, BearerToken : <%APIKey%>
)
Dans une fonction externe, construit les paramètres de la requête dans <%Params%>, un argument local dont le nom est libre : le tableau (nom, valeur) n'est créé que si le paramètre <%Limit%> est renseigné, sinon <%Params%> vaut Nul et aucun paramètre n'est ajouté. L'API est appelée avec un jeton Bearer.
ConvertitFichier(
HttpsGet( "api.qrserver.com/v1/create-qr-code/"
, Param : "size=125x125"
, Param : "margin=10"
, Param : "data="+ConstruitJSON( "name" : "un petit test", "serialnumber" : "IW-001" )
)
, "qrcode.png"
)
Génère un QR code avec un service web et le convertit en fichier image nommé qrcode.png. Chaque paramètre est encodé automatiquement par Param, y compris le JSON passé dans data.
HttpsGet( "api.ppd.iopole.fr/v1/invoice/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/download"
, ClientId : "xxxxxx"
, ClientSecret : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
, OAuth2_AccessToken_Uri : "auth.ppd.iopole.fr/realms/iopole/protocol/openid-connect/token"
, OAuth2_Grant_Type : "client_credentials"
, OAuth2_Spec_Omettre_Scope_Si_Vide : Vrai
, TraiteRetour : ConstruitJSON( "code" : <% Code %>
, "body" : <% Corps %>
, "mimetype" : <% MimeType %>
, "multipart" : <% MultiPart %>
)
)
Télécharge une facture avec une authentification OAuth2 de type client_credentials, sans scope. Retourne un JSON contenant le code de retour, le corps, le type MIME et le contenu multipart de la réponse. Avant la version 2641 de SIMAX, l'option OAuth2_Spec_Omettre_Scope_Si_Vide s'écrit OAuth2_Spec_Ommetre_Scope_Si_Vide.
HttpsGet( "www.org.com/6803/open-book.jpg"
, Entête : "Host: www.org.com"
)
Récupère une image. L'en-tête Host force l'origine de la requête et évite une erreur 404.
HttpsGet( "api.exemple.fr/documents/multipart"
, TraiteRetour : ConstruitJSON( "code" : <% Code %>
, "body" : <% Corps %>
, "mimetype" : <% MimeType %>
, "multipart" : <% MultiPart %>
, "cid" : ValeurJSON( <% Corps %>, "/[1]/cid" )
, "base64" : EncodeBase64( ValeurTableau( <% MultiPart %>, ValeurJSON( <% Corps %>, "/[1]/cid" ), 2 ) )
)
)
Lit le cid indiqué dans le corps de la réponse (un JSON), puis encode en base64 le multipart correspondant : ValeurTableau retrouve la ligne de <% MultiPart %> par son cid et retourne son 2e élément, le multipart.