• HOME

• リファレンス

リファレンス

翻訳元記事はこちらです。

WordPress REST APIは、RESTを中心に構成されており、予測可能なリソース指向のURLを持ち、HTTPエラーコードを使用してAPIエラーを示すように設計されています。
APIは組み込まれているHTTPの機能を利用します。すでにあるHTTPクライアントが理解できる、HTTPの認証やHTTPのメソッドのような。
そして、APIはクロスオリジンリソース共有をサポートしており、クライアント側のwebアプリケーションから、APIと安全に対話できるようになっています。

REST APIはリクエストとレスポンスの形式として、JSONを使用します。（エラーのレスポンスも含めて）
REST APIは、完全にはHAL標準には準拠しておらず、APIリソースとリンクするために、HALの._linksと._embeddedプロパティを実装しています。
REST APIは、レスポンスのハイパーリンクを通して完全に発見することができます。

REST APIは、どの匿名のクライアントにも、公開しているデータを提供します。同様に、認証後には非公開のデータも提供します。
一度認証されたREST APIは、管理者の操作や、サイトの代替のダッシュボードを作成したり、あなたのプラグインをもっと使いやすくしたり、シングルページアプリケーションを作成するのをサポートします。

このAPIリファレンスでは、APIのパラメーターと、レスポンスのデータのフォーマット、APIを通じて利用できる特定のエンドポイントについて説明します。

REST APIのエンドポイントのリファレンス

分配されるAPI

他の多くのREST APIとは違い、WordPress REST APIは、各サイトで個別に配布および利用できます。
そのため、コンタクトを取れるAPIのルートがありません。その代わり、発見するための方法があります。
APIは、インデックスのエンドポイントを叩くことによって、自身のドキュメントを表示することができます。
さらにAPIは、どのエンドポイントでも、OPTIONSリクエストを通して、エンドポイントで何ができるかを表示することができます。

APIテスト用のデモインストールは、https://demo.wp-api.org/wp-json/で利用できます。このサイトでは、APIドキュメントの表示と、読み取り専用のデモデータを提供しています。