Name: APICall
Rating: 4.6 (114 reviews)
Author: CoCoTTe42

╭───
≡ General description
╰─
APICall is a widget for calling HTTP URLs throught Bluetooth via Smartphone or directly with WiFi/LTE for compatible devices.
Typical usage is for calling REST API of IOT devices, home automation boxes - domotics (Fibaro, eedomus, jeedom, zipa, vera, ...) or others things via ifttt.com, zapier ...

If you like it, give me a beer here ;o)
→ https://paypal.me/apicall
→ Bitcoin : bc1quuyugk3czzpp4zcr2j9kln4ju6hd9z27ef3y09

Garmin limits this description to 4 000 chars, the complete documentation is here :
https://apicall.dumesnil.net

╭───
≡ Usage
╰─
When you launch widget, press START or MENU. Select a device then an action, then press START button to launch. "OK" or "KO" with the HTML error code is displayed.
Press MENU to select a new device/action.
Note :
‣ "START" can be START button and/or a "tap" on screen for touch watches.
‣ "MENU" can be a long press on UP button, on bottom right button (Vivoactive 4), on the screen (touch watches)…

╭───
≡ Configuration
╰─
⤇ The configuration is done in settings menu in Garmin ConnectIQ application. There is 36 lines that have to be set as a JSON string like :
» Example (basic) : {deviceName:"Gate", actionName:"Open", url:"http://my.url?to=open"}
» Example (with icons and autonext) : {deviceName:"Cinema", deviceIcon:7, autonext:true, actionName:"TV", actionIcon:11, url:"http://my.url?tv=on"}

• deviceName [mandatory] :
 ‣ Type : string
 ‣ Description : Set the name of the device to which the action belongs. It permit to group some actions under a same device.

• deviceIcon [optionnal] :
 ‣ Type : integer
 ‣ Default : 1
 ‣ Description : Icon to be displayed next to the name of the device.

• autonext [optionnal] :
 ‣ Type : boolean [true|false]
 ‣ Default : false
 ‣ Description : When launching an action, the next action of the device is automatically selected.

• actionName [mandatory] :
 ‣ Type : string
 ‣ Description : Name of the action

• actionIcon [optionnal] :
 ‣ Type : integer
 ‣ Default : 2
 ‣ Description : Icon to be displayed next to the name of the action.

• url [mandatory] :
 ‣ Type : string
 ‣ Description : URL to be launched

• autolaunch [optionnal] :
 ‣ Type : boolean [true|false]
 ‣ Default : false
 ‣ Description : Applies to the action. The action is launched immediatly after selection. Can work with autonext.

• method [optionnal] :
 ‣ Type : string
 ‣ Default : "GET"
 ‣ Description : ["GET"|"POST"|"PUT"], set the HTTP request type. 

• POSTcontent [optionnal] :
 ‣ Type : string
 ‣ Default : ""
 ‣ Description : Send as request content with all method (GET, POST and PUT). It must contain a JSON type string. Be carreful to escape the " in the content if necessary. Exemple to send {"args":["3"]} : {POSTcontent:"{"args":["3"]}"}. 

• resDisplay [optionnal] :
 ‣ Type : string
 ‣ Default : ""
 ‣ Description : Put a JSON path to fetch the element to display. If not defined, only the message OK or KO + error code is displayed as return. If "text", the response is displayed as it is (pay attention to the length of the response…) Ex : if result is {"myres":"xxx"}, xxx is displayed with resDisplay:"myres".
Ex : if result is {"myres":["id":"xxx", "id":"yyy"]}, xxx is displayed with resDisplay:"myres[0].id".

• media [optionnal] :
 ‣ Type : string
 ‣ Default : ""
 ‣ Description : ["BT"|"WIFI-LTE"], force to launch the request through a specific media. If not set, default behavior is BT if connected, else Wifi/LTE.

• headers [optionnal] :
 ‣ Type : string
 ‣ Default : "{}"
 ‣ Description : This option permit to set custom http headers. The main usage is to set the "Content-Type" and "Authorization" headers. Garmin do some checks that prevent to send everything you want, and these checks are unfortunately not documentated... To use the option, you need to configure a json with pairs of "name of the headers":"content of the header". See web site for more examples.

APICall

╭───
≡ Description générale
╰─
APICall est un widget pour effectuer des requêtes HTTP, via le smartphone ou directement via WiFI ou LTE.
L'usage principal est l'appel à des API REST d'équipements IOT ou de box domotique (Fibaro, eedomus, jeedom, zipa, vera ...) ou autres via ifttt.com, zapier...

Si vous aimez, payez moi une bière ;o)
→ https://paypal.me/apicall
→ Bitcoin : bc1quuyugk3czzpp4zcr2j9kln4ju6hd9z27ef3y09

Garmin limite cette description à 4 000 caractères, la documentation complète et le guide d'utilisation est ici :
https://apicall.dumesnil.net (en anglais)

╭───
≡ Utilisation
╰─
Lorsque le widget est lancé, appuyer sur START ou MENU. Sélectionner la cible et l'action, puis appuyer sur le bouton START. "OK" ou "KO" avec le code d'erreur HTML est affiché.
Appuyer sur MENU pour sélectionner un nouveau couple cible/action.
Note : 
‣ "START" : bouton START et/ou "tap" sur l'écran avec les montres tactiles
‣ "MENU" : pression longue sur le bouton UP, le bouton en bas à droite (Vivoactive 4), l'écran (montres tactiles) ...

╭───
≡ Configuration
╰─

⤇ La configuration s'effectue dans les options de l'application ConnectIQ. Chacune des 36 lignes permet de configurer une action sous la forme d'un JSON tel que :
» Exemple simple : {deviceName:"Portail", actionName:"Ouvrir", url:"http://mon.url?pour=ouvrir"}
» Exemple avec icônes et autonext : {deviceName:"Cinema", deviceIcon:7, autonext:true, actionName:"AllumerTV", actionIcon:11, url:"http://mon.url?allumer=tv"}

• deviceName [obligatoire] :
 ‣ Type : string
 ‣ Description : Permet de regrouper plusieurs actions sous une même cible.

• deviceIcon [optionnel] :
 ‣ Type : entier
 ‣ Default : 1
 ‣ Description : Icône affichée à côté du nom de l'action (cf screenshot pour la liste).

• autonext [optionnel] :
 ‣ Type : booléen [true|false]
 ‣ Default : false
 ‣ Description : Lors du lancement d'une action, l'action suivante de la cible est automatiquement sélectionnée.

• actionName [obligatoire] :
 ‣ Type : string
 ‣ Description : Nom de l'action à effectuer.

• actionIcon [optionnel] :
 ‣ Type : entier
 ‣ Default : 2
 ‣ Description : Icône affichée à côté du nom de la cible (cf screenshot pour la liste).

• url [obligatoire] :
 ‣ Type : string
 ‣ Description : URL de l'action à appeler.

• autolaunch [optionnel] :
 ‣ Type : booléen [true|false]
 ‣ Default : false
 ‣ Description : L'action est lancée dès sa sélection.

• method [optionnel] :
 ‣ Type : string
 ‣ Default : "GET"
 ‣ Description : ["GET"|"POST"|"PUT"], définit le type de requête HTTP. 

• POSTcontent [optionnel] :
 ‣ Type : string
 ‣ Default : ""
 ‣ Description : Est envoyé comme corqs de la requête quel soit la méthode (GET, POST, PUT), doit contenir un chaine de caractère de type JSON. Attention à bien échapper les " dans le contenu. Ex pour envoyer {"args":["3"]} : {POSTcontent:"{"args":["3"]}"} 

• resDisplay [optionnel] :
 ‣ Type : string
 ‣ Default : ""
 ‣ Description : Chemin JSON de la réponse à afficher. Si non défini, OK ou KO + code erreur est affiché en retour. Si "text", la réponse est affichée telle quelle (attention à la longueur de la réponse !) Ex : si le retour est {"myres":"xxx"}, pour afficher xxx il faut indiquer resDisplay:"myres".

• media [optionnel] :
 ‣ Type : string
 ‣ Default : ""
 ‣ Description : ["BT"|"WIFI-LTE"], force le media à utiliser pour envoyer la requête. Par défaut : BT si connecté, sinon Wifi/LTE.

• headers [optionnel] :
 ‣ Type : string
 ‣ Default : "{}"
 ‣ Description : Cette option permet de configurer les headers http. L'usage principale est destiné à configurer "Content-Type" et "Authorization". Garmin fait des vérifications sur le contenu des en-têtes, et malheureusement ceci n'est pas documenté. Il faut configurer un json sous la forme de paires de paramètres du type "nom de l'entête":"contenu". Voir le site web pour plus d'exemples.