Request Format REST

REST のアプリケーションは非常に簡単です。それは単純なHTTP GET 又は HTTP POSTの操作によるものです。

メソッドにはGET と 他にはPOSTが必要となります。一般に; お客様が私達に情報を送る際はPOSTをご使用下さい。私達に情報を送るように要求される際にはGETをご使用下さい。このドキュメント内にて、メソッドの正しい取り扱いについての判断が出来ます。

Url

全てのアプリケーションの際のURL: https://api.webcron.org/
又はセキュリティー保護されていないアプリケーションの際 : http://api.webcron.org/

GET の例

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

"api.webcron.org/"の後の部分が申請のメソッドです。上記の例では、このメソッドはmonitor.getです。メソッドの後に、パラメーターを追加する事が出来ます。 パラメーターのフォーマットは: 名前:値 (name:value)又は, 複数の値の場合: 名前:値 (name:value),値2,値3

POST (ポスト)とencode(エンコード)

ポストされたフォーマットは次の通りです : "fieldName=value".

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

の全ては正しくエンコードする必要があります。下記の例では、"url" と"post"の後の部分がエンコードされます。これを行うのには複数の言語があります(php: urlencode(), javascript: escape()). 又は オンラインのエンコード・ツールをご使用下さい。

cURL POST の例

下記は cURL 使用してモニターを追加する為の例です。ApiUsername と ApiPassword をお客様自身のもの に交換して下さい。

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