REST API はじめに
SportsPress 2.0 では WP REST API 向けのエンドポイントが導入され、プログラムからサイトデータを管理できるようになりました。WordPress 4.7 以降では REST API がネイティブに組み込まれているため、追加プラグインは不要です。
GET リクエスト(データの読み取り)は認証不要です。POST・PUT・DELETE リクエスト(データの作成・更新・削除)には認証が必要です。
ベース URL
SportsPress REST API のすべてのエンドポイントは以下の URL 以下で利用できます:
/wp-json/sportspress/v2/
example.com をご利用のサイトのドメインに置き換えてください:
https://example.com/wp-json/sportspress/v2/events
利用可能なエンドポイント
リソース | エンドポイント |
試合 |
|
チーム |
|
選手 |
|
スタッフ |
|
カレンダー |
|
リーグ表 |
|
選手リスト |
|
各エンドポイントは標準的な WordPress REST API の規約に従っています。GET でリソース一覧を取得、GET /{id} で単一リソースを取得、POST で作成、PUT または PATCH で更新、DELETE で削除できます。
HTTP メソッド
メソッド | 操作 |
| リソースを 1 件または複数取得 |
| 新しいリソースを作成 |
| 既存のリソースを更新 |
| リソースを削除 |
認証
書き込み操作にはすべて認証が必要です。アプリケーションパスワードと Postman を使用したセットアップ手順については、認証の記事をご覧ください。
既知の制限事項
REST API 経由で作成した選手は選手リストに自動的に表示されない場合があります。API で選手を作成した後、管理画面で手動で関連チームに割り当てるか、その選手リストがそのチームを含む設定になっているか確認してください。
予定(未来)の試合を API で作成する場合は、ステータス値に
futureを指定する必要があります。_fieldsクエリパラメーターはレスポンスフィールドのフィルタリングに対応しています(SportsPress Pro 2.7.16 以降で利用可能)。
