EDD REST API – エンドポイント

EDD REST API には、情報を取得するための6つのエンドポイントが含まれており、それぞれが特定の種類の要求を実行します。

• stats – 特定の日付、期間、および特定の製品の収益/売上統計を取得するため。
• products – ストア製品に関する情報を取得するため。
• customers – 顧客統計を取得するため。
• sales – 最近の売上および各売上の情報（購入アイテム、購入者、金額など）を取得するため。
• discounts – 利用可能なすべての割引に関する情報を取得するため。
• download-logs – ファイルダウンロードのログを取得するため。

エンドポイントは次のように使用されます。

https://example.com/edd-api//

例えば：

https://example.com/edd-api/sales/

APIキーとトークンと組み合わせると、完全なURLはこのようになります。

https://example.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70

可視性

製品エンドポイントを除き、すべてのアンドポイントでAPIキーとトークンが必要です。これは、製品がデフォルトで常に公開されることを意図しているためです。

応答形式

EDD APIから提供される応答は、2つの形式で利用できます。

• JSON (デフォルト)
• XML

返される形式を指定するには（指定がない場合はJSONが使用されます）、URLに
format 引数を追加するだけです。

https://yoursite.com/edd-api/sales/?key=c281cf0a95be875d9eeb284fb004c938&token=5f9432f3ffa5945755ebc66179810d70&format=xml

JSON応答のサンプルは次のようになります。

{
    "sales": [
        {
            "ID": 611,
            "subtotal": "20",
            "tax": 0,
            "fees": false,
            "total": "20",
            "gateway": "manual",
            "email": "[email protected]",
            "date": "2013-02-25 11:42:05",
            "products": [
                {
                    "name": "Simple Notices Pro",
                    "price": "20",
                    "price_name": "Price one"
                }
            ]
        }
    ]
}

XML応答のサンプル（同じクエリの場合）は次のようになります。

  
    611
    20
    0
    false
    20
    manual
    [email protected]
    2013-02-25 11:42:05
    
      Simple Notices Pro
      20
      Price one
    
  

オプションのURL変数

提供される出力を調整するために、追加のURL変数を含めることができます。これを行う方法の例をいくつか示します。

• 件数：デフォルトでは、APIはWordPressの「表示設定」で設定されているとおり、1ページあたり10件の結果を表示します。ただし、特定のAPI呼び出しでこれを変更したい場合は、「&number=11」をURLに追加して、1ページあたりの結果の件数を変更できます。この例では、11件の結果が得られます。
• ページ：デフォルトでは、APIは結果のページ番号1を表示します。特定のAPI呼び出しでこれを変更したい場合は、「&page=2」をURLに追加して、結果の別のページを取得できます。