Etsy APIとは？
Etsyはプラットフォームのデータを取得・更新するための公開APIを提供しています。APIは開発者が特定のプログラムやウェブサイトの独自データや機能を活用したアプリを作成するためのものです。同様に、開発者はEtsy APIを使って売り手や買い手向けの連携機能を作成します。
Etsy APIキーの取得方法
EtsyのウェブAPIへのアクセスはそれほど時間や労力を必要としません。まずはEtsy開発者コミュニティのサイトにアクセスし、そこで独自のAPIキーを使ってアプリや連携機能の作成を始められます。以下のEtsy APIチュートリアルで、このプログラミングインターフェースへのアクセス方法を解説します。
- ステップ1 – アカウント作成
Etsy開発者コミュニティのサイトにアクセスし、新規登録するか既存のアカウントでログインしてください。
メールアドレスで登録するか、Google、Facebook、Appleアカウントでのログインも可能です。 - ステップ2 – セキュリティ設定の調整
最初のアプリを作成する前に、二段階認証の設定が必要です。
リンクをたどるとセキュリティ設定のページに移動します。
いくつかの選択肢があります。例えば、Google Authenticatorアプリをスマホにインストールし、アプリ内の確認コードでアクセスを認証する方法です。このオプションを選ぶと、アプリのダウンロードとQRコードを使ったEtsy開発者ポータルとの連携が案内されます。
電話認証やSMS認証も選べます。この場合は電話番号を入力し、「次へ」を押すと、選択した方法に応じてSMSコードか自動音声通話が届きます。
- ステップ3 – アプリケーションの作成
セキュリティ設定が完了したら、最初のアプリを作成できます。まずはアプリの概要を記入するフォームに入力してください。
Captchaを完了し、「利用規約を読む」と「アプリを作成」をクリックします。
ポップアップでEtsy APIの利用規約が表示されます。内容をよく読み、API利用時の条件や制限を理解してください。チェックボックスにチェックを入れて「アプリを作成」を押します。
- ステップ4 – API認証情報の取得
利用規約に同意すると、APIキーとシークレットが発行されます。
API認証情報は秘密にして、第三者に見せたり送ったりしないように注意してください。
Etsy APIの使い方
アプリを初めて作成すると、開発中はデフォルトで「暫定アクセス（Provisional Access）」が付与されます。暫定アクセスでは以下の機能が利用可能です：
- 公開されている認証不要のリソース（ショップやトレジャリーなど）への読み取りアクセス。
- アプリ所有者のデータに対する認証済み（読み書き）アクセス。これにより、レシートや請求情報の閲覧、ショップの出品の作成・編集・削除が可能です。必要に応じて、テストユーザーの小グループにもアクセス権を申請できます。
Etsyはさらに「フルアクセス（Full Access）」も提供しており、無制限のEtsyメンバーのデータに対する認証済みアクセスが可能です。もし開発中の連携機能にそこまでの権限が不要なら、暫定モードのまま利用できます。
フルアクセスを希望する場合は、まず暫定アクセスでアプリを開発・動作確認し、その後プラットフォームのフルアクセス要件を満たしているか確認してください。
Etsy APIの例
EtsyレビューAPI
Etsyプラットフォームには、買い手と売り手がお互いに取引に関するフィードバックを残せる「フィードバックシステム」があります。特定の種類のフィードバックを取得するための複数のメソッドが用意されており、例えばfindAllUserFeedbackAsAuthor, findAllUserFeedbackAsBuyer, findAllUserFeedbackAsSellerなどがあります。
以下は、買い手からのフィードバックを取得できるfindAllFeedbackFromBuyersメソッドの例です。
| メソッド名 | findAllFeedbackFromBuyers |
| 概要 | ユーザーに関連するフィードバックオブジェクトの集合を返します。これは基本的にfindAllUserFeedbackAsBuyerとfindAllUserFeedbackAsSubjectメソッドの合成です。 |
| HTTPメソッド | GET |
| URI | /users/:user_id/feedback/from-buyers |
もしEtsyショップのカスタマーレビューを表示する方法を探しているなら、すぐに使えるレビューウィジェットを試してみてください！
Etsy決済API
決済およびトランザクションAPIはEtsyセラーツールの一部です。Etsyプラットフォームでの売買は主に注文、レシート、トランザクションの3つのソースに分かれます。そして決済APIはEtsy Paymentsによる支払いを表します。
Etsy出品API
Etsyの出品は販売可能なアイテムを指します。各出品はユーザーとショップ（そのショップの所有者）に紐づいています。出品には価格と数量が設定され、売り切れると再度販売可能にするためにショップオーナーが更新する必要があります。出品APIは様々なカテゴリの出品を検索・取得したり、出品の作成・削除を行うメソッドを提供しています。カテゴリにはアクティブ、興味深い、トレンド、レシートなどがあります。Etsy出品APIのfindAllShopListingsActiveメソッドは、ショップに属するすべてのアクティブな出品を取得します。
Etsy APIドキュメント
Etsy開発者コミュニティのサイトには、充実したドキュメントセクションがあります。Etsy APIを初めて使う開発者向けには基本ガイドも用意されています。Etsy開発者APIポータルの特徴的なセクションとしてディスカッションセクションがあり、誰でも参加して質問や経験の共有ができます。
よくある質問
EtsyにAPIはありますか？
はい、Etsyは売り手向けと買い手向けの2つの主要カテゴリに分かれた幅広い開発者向けソリューションを提供しています。EtsyウェブAPIへのアクセスは広く無料で提供されています。
Etsyの出品IDはどこで確認できますか？
Etsyの各出品には固有の識別番号があります。これは出品のURLの末尾に記載されています。出品ページのURLは「www.etsy.com/listing/出品ID/」の形式です。
Etsy APIキーとは何ですか？
Etsy APIを使うには、アプリ登録時に発行される固有のアプリケーションキーが必要です。このAPIキーはEtsyウェブプラットフォームにアプリを識別させ、呼び出し制限の管理に使われます。
Etsy APIキーはどこで見つけられますか？
作成したEtsyアプリごとに固有のAPIキーは、Etsy開発者アカウントの「作成したアプリ」タブで確認できます。まだ開発者アカウントやアプリを作成していない場合は、この記事の上部の該当セクションを参照してください。
