フォト蔵APIとは、他のプログラムからフォト蔵にアクセスするために提供している外部プログラムインターフェースです。
フォト蔵APIを使用することによって、フォト蔵アップローダー「
貼る蔵」のようなプログラムを作成することができます。
APIによるアクセスは1リクエスト/秒を目安としてください。サービスに影響の出る過剰なアクセスは制限させていただく場合がありますのでご了承ください。
フォト蔵APIに対する要望や質問は、
フォト蔵APIコミュニティにお寄せください。
フォト蔵APIは開発段階であり、予告なく仕様が変更される場合があります。
概要
フォト蔵APIは、メソッドごとにURLが決まっていて、それぞれのURLに対してHTTP GET/POSTリクエストを使用してアクセスします。
メソッドによっては、HTTP POSTリクエストしか受けないメソッドがあります。
詳細は、各メソッドの説明を参照してください。
URL
APIのURL形式は次のようになります。
http://api.photozou.jp/rest/メソッド名
メソッド名は、APIの固有の名前です。
認証
APIによっては認証が必要になります。
認証はBasic認証で行ないます。
文字コード
文字コードはUTF-8を推奨します。
サーバ側で文字コードの自動判別を行なっているので、
EUC-JP, Shift_JISも使えます。
データを送信するときに"dummyinput"というパラメータに適当な文字列を挿入すると、
文字コードの自動判別がより正確に行なえるようになります。
レスポンス
結果は全てXMLで返ってきます。文字コードはUTF-8です。
返ってくるXMLの形式は成功した場合と失敗した場合の2種類あります。
成功した場合:
<?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を使うプログラムから使用されることを意図しています。
エラーコードについては
エラーコード一覧をご覧下さい。
エラーメッセージには利用者に対するメッセージが入ります。
メッセージは状況によって変化する可能性があります。
メソッド
