WordPress REST APIは、WordPressのウェブサイトと外部アプリケーションを接続することを可能にします。質的にあらゆるプログラミング言語を使ってモバイルアプリを開発し、WP REST API を使って WordPress からデータを取得することができるのです。
APIとは「アプリケーション・プログラミング・インターフェース(Application Programming Interface)」の略称です。
一言で表すと、ソフトウェアやプログラム、Webサービスの間をつなぐインターフェースのことを指します。Wordpress では、Wordpressのページや投稿の参照、登録などを外部から操作することが可能な REST APIが提供されています。
REST APIは、すでに多くの主要なWebサイトで実用化されています。
REST APIは、WordPress固有の構造から解放され、アプリケーションの作成に役立てることができる方法です。
WordPress REST APIは何に使うのですか?利用概念は?用語
従来、WordPressのREST APIにアクセスするためには、プラグインが必要でした。
しかし、バージョン4.4以降、このWP APIはコアソフトウェアとなりました。WordPress REST API の仕組みを理解するために、いくつかの概念や機能を知っておく必要があります。
4種類のHTTPメソッド理解
そのため、REST APIを利用するには、4種類のHTTPメソッドを使用してリクエストする方法を知る必要があります。
- GET: サーバーから情報を取得
- POST: 当該サーバーに情報を送信する
- PUT: 既存のデータを編集・更新することができます。
- DELETE: 情報を削除することができます。
ルートかエンドポイントなど
WordPressAPIを使っていると、何度も同じ用語が出てきますが、それは以下のようなものです。
エンドポイント
ルートがマップする必要のある行き先のことです。
エンドポイントとは、APIを通じて利用できる機能のことです。これは、API インデックスの取得、投稿の更新、コメントの削除などです。複数の異なるエンドポイントを登録することができます。
ルート
エンドポイントにアクセスするために使用する「名前」であり、URLで使用されます。ルートは複数のエンドポイントを関連付けることができ、どのエンドポイントを使用するかは HTTP メソッドに依存します。
ルートは URI で表現されます。
ルート自体は https://xxx.com/wp-json
の末尾に貼り付けられているものです。API のインデックスルートは '/'
です。これが https://ourawesomesite.com/wp-json/
が API で利用可能なすべての情報を返す理由です。すべてのルートはこのルートの上に構築されるべきで、wp-json
の部分は変更することができますが、一般的には同じままにしておくことをお勧めします。
REST APIの概念と用語
「Representational State Transfer(REST)」は、ウェブシステムが連動するための標準です。RESTがないと、2つのシステムはお互いを理解できず、データをやり取りできません。
リクエスト
エンドポイントを送信すると、サーバーにリクエストをすることになります。
レスポンス
エンドポイントが正しい方法で構造化されていれば、欲しい情報を含むJSON(JavaScript Object Notation)か、エラーが返されるでしょう。
スキーマ
スキーマとは、データがどのように構造化されているかを示すメタデータのことです。
ほとんどのデータベースは、より構造化された方法でデータを推論できるように、何らかのスキーマを実装しています。
WordPress REST API は JSON スキーマを利用してデータの構造化を処理します。スキーマを使わずにエンドポイントを実装することもできます。
REST APIエンドポイント
ほとんどの場合、WordPress REST API経由でリクエストを送信します。
すでに存在するルートとエンドポイントを使用することになります。
これらのエンドポイントが何であるかを知ることは、WP APIをマスターし、独自のプロジェクトを開発するためにそれを使用するための第一歩です。
REST API の認証
WordPressはあなたが誰であるか、そしてあなたがブラウザ経由かREST API経由かを確認できない限り、特定のデータにアクセスすることを許可しません。
認証を必要とする機能、例えばコンテンツの投稿などには別途 認証用Pluginなどを必要とします。
クッキー認証
そのサイトで有効化されたテーマやプラグインから利用するためを目的とします。
OAuth 認証/ベーシック認証
外部からのAPIリクエストを目的とします。
OAuthとは、複数のWebサービスを連携して動作させるために使われる仕組みです。
通常、Webサービスを利用するためは、個別にユーザーIDとパスワードを入力してユーザーを認証する必要がありますが、OAuthを利用することで、IDやパスワードを入力することなく、アプリケーション間の連動ができるのです。
まとめ
次回はWordPress REST API の使い始め方(3ステップについて説明いたします)
コメント