APIキー

Fotolia APIを利用できるようにするためには、APIキーを入手する必要があります。APIを通して要求を行うにはこのAPIキーが必須です。APIキーは、Fotoliaにログイン後、規定／API　＞　APIについて　のページへと進み、「APIキーを入手する」のリンクから必要事項を入力して申請、入手することができます。APIキーには、パートナーAPIキー、ビジネスAPIキー、開発者APIキーの三種類があります。お手持ちのAPIキーによっては、使用できないメソッドがあります。下の表を参照してどのメソッドが使用できるかを確認してください。複数のAPIキーを持つことが可能です。作成した各アプリケーションは異なるAPIキーと関連付けなければなりません。

APIの一般使用規定

APIの一般使用規定は、それぞれのAPIを使うことができる権利および条件を定めたものです。ご使用前に、APIの一般使用規定を読んで理解してください。

コード

Fotolia APIでは、全てのデータが UTF-8でエンコードされている必要があります。 詳細についてはここをご覧ください。

認証

メソッドによっては認証が必要になります（下の表を参照してください）。認証があるのは開発者APIおよびビジネスAPIの場合のみです。認証プロセスはFotoliaのサイトにおける本人確認手順（ログイン）のようなものです。ログインおよびパスワードを、APIによりセキュア化された方法で送信するものとし、それらが確認されるとセッションIDが割り当てられます。次に、認証をともなうメソッドを利用する場合にこのセッションIDが必要になります。認証についての詳しい情報については、メソッドloginUserを参照してください。

メソッド

メソッドにより、APIを通してさまざまな機能を実行することができます。下の表は各タイプのAPIで利用できる方法を示したものです。今後、他の方法が追加される予定です。

メソッド パートナーAPI ビジネスAPI 開発者API リセラーAPI 認証 説明
検索
getSearchResults Authorized Authorized Authorized Authorized いいえ 強力検索
getCategories1 Authorized Authorized Authorized Authorized いいえ 描写カテゴリーを返す
getCategories2 Authorized Authorized Authorized Authorized いいえ 概念カテゴリーを返す
getTags Authorized Authorized Authorized Authorized いいえ タグクラウドを返す
getGalleries Authorized Authorized Authorized Authorized いいえ 公開ギャラリーを返す
getColors Authorized Authorized Authorized Authorized いいえ カラーテーブルを返す
getCountries Authorized Authorized Authorized Authorized いいえ 国一覧
メディア
getMediaData Authorized Authorized Authorized Authorized いいえ メディアに関する全情報を返す
getMediaGalleries Authorized Authorized Authorized Authorized いいえ メディアに関するギャラリーを返す
getMedia Prohibited Authorized Prohibited Authorized はい ダウンロードリンク（購入したメディア）を返す
getMediaComp Authorized Authorized Authorized Authorized いいえ モックアップイメージのURLを返す
ユーザー
loginUser Prohibited Authorized Authorized Authorized いいえ （認証に必要な）ユーザーを確認する
logoutUser Prohibited Authorized Authorized Authorized はい ユーザーの接続を解除する（セッションを閉じる）
getUserData Prohibited Authorized Authorized Authorized はい IDが確認されたユーザーの情報を返す
getUserStats Prohibited Authorized Authorized Authorized はい IDが確認されたユーザーのアカウントの統計を返す
getUserGalleries Prohibited Authorized Authorized Authorized はい IDが確認されたユーザーのギャラリーを返す
getUserGalleryMedias Prohibited Authorized Authorized Authorized はい IDが確認されたユーザーのライトボックス／ギャラリーのイメージを返す
deleteUserGallery Prohibited Authorized Authorized Authorized はい IDが確認されたユーザーのギャラリーを削除する
createUserGallery Prohibited Authorized Authorized Authorized はい IDが確認されたユーザーに対し、あらたにギャラリーを開設する
addToUserGallery Prohibited Authorized Authorized Authorized はい IDが確認されたユーザーのギャラリーにファイルを追加する
removeFromUserGallery Prohibited Authorized Authorized Authorized はい IDが確認されたユーザーのギャラリーからファイルを削除する
getUserAdvancedStats Prohibited Authorized Authorized Authorized はい IDが確認されたユーザーのアカウントの高度統計を返す
Shopping cart
shoppingcart.getList Prohibited Authorized Prohibited Authorized yes Returns shopping cart content
shoppingcart.add Prohibited Authorized Prohibited Authorized yes Add a media to the user's shopping cart
shoppingcart.update Prohibited Authorized Prohibited Authorized yes Update a media into the user's shopping cart
shoppingcart.remove Prohibited Authorized Prohibited Authorized yes Remove a media from the user's shopping cart
shoppingcart.transferToLightbox Prohibited Authorized Prohibited Authorized yes Remove a media from the user's shopping cart and add to to his lightbox
shoppingcart.clear Prohibited Authorized Prohibited Authorized yes Clear the user's shopping cart
メイン
getData Authorized Authorized Authorized Authorized いいえ Fotoliaについての一般情報を返す
test Authorized Authorized Authorized Authorized いいえ "success" を返す
リセラーAPI
user.subaccount.getIds Prohibited Prohibited Prohibited Authorized いいえ 全ての有効なサブアカウントIDの配列を返します。
user.subaccount.create Prohibited Prohibited Prohibited Authorized いいえ 全ての有効なサブアカウントIDの配列を返します。
user.subaccount.delete Prohibited Prohibited Prohibited Authorized いいえ リセラーサブアカウントを削除します。
user.subaccount.edit Prohibited Prohibited Prohibited Authorized いいえ リセラーサブアカウントのデータを更新します。
user.subaccount.get Prohibited Prohibited Prohibited Authorized いいえ リセラーサブアカウントを削除します。
user.subaccount.getPurchasedContents Prohibited Prohibited Prohibited Authorized いいえ リセラーサブアカウントを削除します。
media.getLicense Prohibited Prohibited Prohibited Authorized いいえ 特定の販売における、リセラーと顧客間のライセンスを取得します。

クエリーのフォーマット

XML/RPC

クエリーおよびレスポンスについてはXML／RPCフォーマットが有効です。XML－RPCはインターネット上で作動するプロトコル（リモートプロシージャコール）です。XML－RPCメッセージはHTTP-POSTクエリーです。クエリーのボディ部分はXMLになっています。このプロシージャはサーバー上で実行され、サーバーが返す値もまたXMLフォーマットです。. 詳細についてはここを参照してください XML/RPC

ヘッダー 


POST /Xmlrpc/rpc HTTP/1.0
Host: api.fotolia.com
Connection: close
Content-Type: text/xml
Content-Length: 569

クエリーの例


<?xml version="1.0" encoding="utf-8"?>
<methodCall>
	<methodName>xmlrpc.test</methodName>
	<params>
		<param>
			<value>
				<string>YOUR_API_KEY</string>
			</value>
		</param>
	</params>
</methodCall>

レスポンスの例


<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>test</name>
            <value>
              <string>Success</string>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

APIキット

キットを利用することでAPIの使い方がもっと簡単になります。使用可能なキットの一覧は以下の通りです。キットを選ぶ上で質問がございましたらサポートまでお問い合わせください。ご案内いたします。

PHP

Ruby