フォト蔵APIとは

フォト蔵APIとは、他のプログラムからフォト蔵にアクセスするために提供している外部プログラムインターフェースです。
フォト蔵APIを使用することによって、フォト蔵アップローダー「貼る蔵」のようなプログラムを作成することができます。
APIによるアクセスは1リクエスト/秒を目安としてください。サービスに影響の出る過剰なアクセスは制限させていただく場合がありますのでご了承ください。
画像サムネイルを簡単に取得するためのAPIも別途用意しています。
フォト蔵APIに対する要望や質問は、フォト蔵APIコミュニティにお寄せください。

フォト蔵APIは開発段階であり、予告なく仕様が変更される場合があります。

概要

フォト蔵APIは、メソッドごとにURLが決まっていて、それぞれのURLに対してHTTP GET/POSTリクエストを使用してアクセスします。 メソッドによっては、HTTP POSTリクエストしか受けないメソッドがあります。 詳細は、各メソッドの説明を参照してください。

URL

APIのURL形式は次のようになります。

https://api.photozou.jp/rest/メソッド名.(json|xml)
2013年8月よりAPIがHTTPSに対応、結果をJSONで取得できるようになりました。

メソッド名は、APIの固有の名前です。

認証

APIによっては認証が必要になります。 認証はBasic認証で行ないます。
Basic認証のユーザー名はフォト蔵に登録されたメールアドレスです。
Twitter/Facebookアカウントでユーザー登録された方は、マイページの「設定」よりパスワードを設定していただく必要があります。

文字コード

文字コードはUTF-8を使用してください。

レスポンス

結果はJSONまたはXMLで返ってきます。文字コードはUTF-8です。
返ってくるJSON/XMLの形式は成功した場合と失敗した場合の2種類あります。
 

JSONレスポンス:

成功した場合:
{
  "stat": "ok",
  "キー": "結果のJSONデータ"
}
失敗した場合:
{
  "stat": "fail",
  "err": [
    {
      "code": "エラーコード",
      "msg": "エラーメッセージ"
    }
  ]
}
 

XMLレスポンス:

成功した場合:
<?xml version="1.0" encoding="UTF-8" ?>
<rsp stat="ok">
  結果のXML
</rsp>
失敗した場合:
<?xml version="1.0" encoding="UTF-8" ?>
<rsp stat="fail">
  <err code="エラーコード" msg="エラーメッセージ" />
</rsp>
  • エラーは1回のリクエストで複数回出てくる可能性があります。
  • エラーコードには不変的な文字列が入ります。
    APIを使うプログラムから使用されることを意図しています。
    エラーコードについてはエラーコード一覧をご覧下さい。
  • エラーメッセージには利用者に対するメッセージが入ります。
    メッセージは状況によって変化する可能性があります。

メソッド

フォト蔵写真サムネイル取得用API

フォト蔵では簡単にインターネットに公開されている写真のサムネイル画像の取得を行えるようにしています。
例えば http://photozou.jp/photo/show/784/17561757 のURLの写真の場合、
写真IDは「17561757」になりますが、次のURLでそれぞれ画像にアクセスすることができます(リダイレクトされます)。

  • http://photozou.jp/p/img/17561757 (長辺450pxのサムネイル画像)
  • http://photozou.jp/p/thumb/17561757 (一辺120pxの正方形サムネイル画像)