ApiRequest

Famille: Studio · 2 formes

Ce que fait la commande

Envoie une requête à un service tiers via une connexion API déclarée pour le projet sur aukimi.com. Rend un identifiant de tâche.

Syntaxe

1
ApiRequest(connexion string, methode string, chemin string) → integer
2
ApiRequest(connexion string, methode string, chemin string, corps string) → integer

Paramètres

NomTypeDans les formesRôle
connexionstringtoutesLe nom de la connexion API, tel que déclaré sur aukimi.com.
methodestringtoutesLa méthode HTTP : GET, POST, PUT ou DELETE, en majuscules ou en minuscules.
cheminstringtoutesLe chemin à appeler sur le service, par exemple /scores. Il peut porter une chaîne de requête : /search?q=x.
corpsstring2Corps de la requête, facultatif. Un texte qui se lit comme du JSON part en JSON, le reste en texte brut.

Chaque forme rend

integer

Un identifiant de tâche pour ApiDone(), ApiStatus(), ApiResponse(), ApiJson() et ApiError().

À savoir

  • La clé secrète du service reste sur le serveur d'Aukimi : le jeu ne connaît que le nom de la connexion.
  • Le joueur doit d'abord être connecté (PlayerGuestAsync() suffit). Sinon la tâche échoue tout de suite avec not logged in.
  • Libérez la tâche avec ApiFree() une fois la réponse lue.
  • Éditeur et exports HTML5 seulement : une version native (Bevy) s'arrête sur une erreur de commande non prise en charge.

Exemple · engendré

Forme 1 : la plus courte

DO  Print(ApiRequest("value", "value", "value"))  Sync()LOOP

Forme 2 : avec tous les arguments

DO  Print(ApiRequest("value", "value", "value", "value"))  Sync()LOOP

ApiRequest est appelé et sa réponse est affichée à chaque image. La boucle DO … LOOP n'est pas décorative : un programme BASIC classique s'arrête dès qu'il n'a plus de lignes, et c'est Sync() qui dessine l'image.

Commandes voisines

133 commandes dans Studio