HTTP API Reference

HTTP RPCスタイルのシンプルなAPIを提供しています。現在のところ、キャッシュ管理APIのみをサポートしています。

リクエストとレスポンスlink

リクエストはすべてPOSTメソッドである必要があります。たとえば、cache.lookupをcURLコマンドで実行する場合、次のコマンドを実行します。 なお、URLパラメータはURLエンコードが必要です。

$ curl -XPOST https://console.imageflux.jp/api/cache.lookup \
  -d token=ffff... \
  --data-urlencode url=http://...

レスポンスはJSON形式です。

{
  "ok": true,
  "urls": [ ... ]
}

すべてのレスポンスはok属性を含んでいます。 APIの実行が成功した場合、ok属性は true を返します。 ok属性は、APIが成功したかどうかを示しており、実行結果自体には関係ありません。 たとえば、cache.deleteはキャッシュを削除するAPIですが、キャッシュが削除されたかどうかにかかわらず、APIの呼び出しが成功すれば常に true になります。

APIトークン

ユーザー認証はtokenパラメータによって行われます。APIトークンはユーザーごとに生成されたSHA256ハッシュ文字列です。 APIトークンについては、管理コンソールのアカウント設定画面を参照してください。

Cache Managementlink

cache.lookup: キャッシュされているか確認するlink

指定したURLがキャッシュされているか確認します。 URLのコンテントがキャッシュされている場合、キャッシュされているURLの一覧がレスポンスに含まれます。

リクエストパラメーター

Argument	Example	Required	Description
token	fffff...	yes	APIトークン
url	https://...	yes	コンテントのURL ※URLエンコードが必要です

レスポンス

{
  "ok": true,
  "urls": [
    "http://...",
  ]
}

cache.delete: キャッシュを削除するlink

指定したURLのキャッシュを削除します。 URLのコンテントが正常にキャッシュされた場合、キャッシュが削除されたURLの一覧がレスポンスに含まれます。

リクエストパラメーター

Argument	Example	Required	Description
token	fffff...	yes	APIトークン
url	http://...	yes	コンテントのURL ※URLエンコードが必要です

レスポンス

{
  "ok": true,
  "urls": [
    "http://...",
  ]
}