Format de Requête (REST) Webcron

Une requête REST est très facile à comprendre. C'est une simple action HTTP GET ou HTTP POST .

Des méthodes nécessitent un GET et d'autres un POST. Règle générale; Si vous nous envoyez des informations, vous utilisez un POST. Si vous nous demandez de vous envoyer des informations vous utiliserez un GET. Vous pouvez déterminer la bonne action pour une méthode dans cette documentation.

Url

L'URL pour toutes les requêtes est :   https://api.webcron.org/

ou, pour une requête non sécurisée :  http://api.webcron.org/

Exemple GET

https://api.webcron.org/monitor.get/frequence:1,2/protocol:http

La partie après "api.webcron.org/" est la méthode de la requête. Dans l'exemple ci-dessus, la méthode est monitor.get. Après la méthode, vous pouvez ajouter des paramètres. Le format des paramètres est : name:value ou, dans le cas de plusieurs valeurs : name:value1,value2,value3

POST et encodage

Le format des données postées est le suivant : "fieldName=value".

name=theName&url=http%3A%2F%2Fwww.dothis.com%2Fdo.php%3Fwhat%3Dbackup&frequence=2&
post=what%3Dbackup%26when%3Dnow

Toutes les données dans un POST doivent être correctement encodée. Dans l'exemple ci dessous, la partie après "url" et "post" sont encodées.  De nombreux langages disposent d'une fonction pour faire cela (php: urlencode(), javascript: escape()). Ou utilisez un outil en ligne d'encodage .

cURL POST Example

Ci dessous un exemple utilisant cURL pour ajouter un moniteur. Remplacez ApiUsername and ApiPassword par les  votres.

curl -u ApiUsername:ApiPassword -d name='theName' -d url='http://www.monitorthis.net' -d protocol=http -d frequence=2 api.webcron.org/monitor.add