ImageFlux APIリファレンス

HTTPによるAPIを提供しています。 現在はキャッシュ管理APIおよびLive配信APIのみを提供していますが、今後、各種APIを順次提供予定です。

※Live配信APIについてはSora APIとの互換性を保つため、そのほかのImageFlux APIとは仕様が異なります。詳細はLive配信APIリファレンスを参照してください。

概要link

すべてのAPIの呼び出しはHTTPのPOSTメソッドで実行する必要があり、ペイロードはJSON形式となります。

認証のため、リクエストに際してはエンコード済みのAPIトークンを Authorization ヘッダで渡す必要があります。 APIトークンはAPIトークン管理画面で発行できます。 その際には使用するAPI種別に応じた権限の付与が必要となります。 リクエストで用いるAPIトークンはエンコード済みである必要があります。これはAPIトークン画面の「エンコード済みトークン」ボタンから取得できます。

たとえば、cache.lookupをcURLコマンドで実行する場合、次のコマンドを実行します。

$ API_TOKEN=ffff....
$ curl -XPOST -H "Authorization: bearer $API_TOKEN" https://api.imageflux.jp/cache.lookup \
  -d '{"url": "http://..."}'

各APIのレスポンスのボディも同様にJSON形式となります。たとえば、cache.lookup の場合は以下のようになります。

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

すべてのレスポンスはokプロパティを含んでいます。 APIの実行が成功した場合、okプロパティは true を返します。

キャッシュ管理APIlink

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

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

なお、ImageFluxではHTTPでアクセスされたコンテントとHTTPSでアクセスされたコンテントをキャッシュ上では区別しません。 そのため、URLで指定する際には http:// と https:// のいずれで指定した場合も同一の結果が http:// として返されます。

リクエスト

API基本情報
APIトークン必要権限 キャッシュ操作
APIエンドポイント https://api.imageflux.jp/cache.lookup
リクエストパラメーター
Argument Type Example Required Description
url string "https://..." yes コンテントのURL

cURLでの例:

$ curl -XPOST -H "Authorization: bearer $API_TOKEN" https://api.imageflux.jp/cache.lookup \
  -d '{"url": "http://..."}'

レスポンス

要素
Attribute Type Example Description
ok boolean true APIの実行正否
error string "Something Bad" APIのエラー事由
※okがtrueの時は空文字列
urls stringの配列 ["http://..."] キャッシュが存在するURLの配列
※通常は0件または1件

例:

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

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

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

なお、ImageFluxではHTTPでアクセスされたコンテントとHTTPSでアクセスされたコンテントをキャッシュ上では区別しません。 そのため、URLで指定する際には http:// と https:// のいずれで指定した場合も同一の結果が http:// として返されます。

リクエスト

API基本情報
APIトークン必要権限 キャッシュ操作
APIエンドポイント https://api.imageflux.jp/cache.delete
リクエストパラメーター
Argument Type Example Required Description
url string "https://..." yes コンテントのURL

cURLでの例:

$ curl -XPOST -H "Authorization: bearer $API_TOKEN" https://api.imageflux.jp/cache.delete \
  -d '{"url": "http://..."}'

レスポンス

要素
Attribute Type Example Description
ok boolean true APIの実行正否
error string "Something Bad" APIのエラー事由
※okがtrueの時は空文字列
urls stringの配列 ["http://..."] 削除されたURLの配列
※通常は0件または1件

例:

{
  "ok": true,
  "error": "",
  "urls": [
    "http://...",
  ]
}
  • © pixiv Inc., SAKURA Internet Inc.