RESTなWebサービスをPHPで操作する

はてなブックマークのAtomAPIの概要と、アクセスに必要な環境

今回は、「RESTなWebサービスの利用／開発」の第3回として、より本格的にWebサービスにアクセスする例を紹介します。RESTなWebサービスの1つとして、はてなブックマークの「AtomAPI」を例に取り上げ、Web開発用の簡易スクリプト言語であるPHP（PHP：Hypertext Preprocessor）を使ってブックマークの追加／編集／削除を行う方法を解説します。

AtomAPIは、ブログなどのWeb上の情報を、Webアクセスに用いられるHTTP（Hypertext Transfer Protocol）を通して編集するためのプロトコルです。AtomAPIは通称で、正式には「The Atom Publising Protocol」（略称はAtomPub）と呼びます。

AtomAPIでは、一般にはRESTの形式で通信を行うことが多いです。WebサービスによってはSOAP（Simple Object Access Protocol）に対応していることもありますが、RESTの方がシンプルなので、RESTが使われることが多いようです。

はてなブックマークのAtomAPIは、以下の処理を行うことができます。

（1）ブックマークの新規作成
（2）既存のブックマークの編集
（3）既存のブックマークの削除
（4）ブックマークの一覧の取得

AtomAPIのWebサービスにアクセスするには、GET／PUT／POST／DELETEプロトコル／メソッドを用いたHTTP通信を利用可能なプログラム言語を使います。多くの言語で、これらの各プロトコルに対応したライブラリ等があります。

今回は、言語としてPHPを使うことにします。ただし、PHP標準の機能だけだとHTTPで通信するプログラムを書くのが面倒なので、PEAR（PHPのライブラリ群）の「HTTP_Request」というライブラリを併用することにします。

なお、PEARのライブラリをインストールする方法は、以下の記事などを参照してください。

・【一気に覚えるPHP！】使えるスクリプト！第2回：PEARのライブラリを利用しよう！

Webサービスへの認証

今回の例のように、Webサービスを利用して情報を保存したり更新したりする場合、その作業を誰でも行えるようになっていると、情報を改ざんされたりすることが起こり得ます。そこで、情報の保存などを行えるWebサービスを利用する際には、処理の際にユーザー名／パスワードなどを使った認証を行います（図1）。

認証の手順はいろいろ考えられ、Webサービスによって認証の方法はさまざまです。はてなブックマークのAtomAPIでは、「WSSE」という認証方式を使っています。

はてなブックマークのWSSE認証では、HTTPでアクセスする際に、ヘッダーに以下のような情報を入れて認証を行います。
--------------------------------------------------------------------------------
X-WSSE: UsernameToken Username="ユーザー名", PasswordDigest="パスワード・ダイジェスト", Nonce="セキュリティ・トークン", Created="送信日時（ISO8601表記）"
--------------------------------------------------------------------------------

「セキュリティ・トークン」には、通信のたびにランダムに生成した文字列を指定します。また、パスワード・ダイジェストは、Nonce／Created／パスワードを連結して、SHA-1（一方向ハッシュ関数の1つ）でダイジェスト化し、さらにBase64（電子メールなどで用いられるテキスト・エンコーダ）でエンコードした文字列を指定します。

WSSE認証の処理は、ブックマークの操作をするたびに使いますので、関数にして1つのファイルにまとめておくと良いでしょう。

実際にその関数を作ると、リスト1のようになります。この関数にパラメータとしてHTTP_Requestクラスのオブジェクトを渡すと、WSSE認証用のヘッダーが付加されます。なお、リスト1は「auth_wsse.php」というファイル名で保存することにします。3行目の「ユーザー名」と4行目の「パスワード」は、ご自分のはてなブックマークでのユーザー名／パスワードに合わせて書き換えます。
--------------------------------------------------------------------------------
【リスト1】 WSSE認証を行う関数
function set_auth_wsse(&$req) {
　 　 　$user = 'ユーザー名';
　 　 　$pass = 'パスワード';

　 　$created = date('Y-m-d\TH:i:s\Z');
　 　 　$nonce = pack('H*', sha1(md5(time())));
　 　 　$nonce_base64 = base64_encode($nonce);
　 　 　$pass_digest = base64_encode(pack('H*', sha1($nonce . $created . $pass)));
　 　 　$wsse = "UsernameToken Username=${user}, PasswordDigest=${pass_digest}, Created=${created}, Nonce=${nonce_base64}";
　 　 　$req->addHeader('X-WSSE', $wsse);
}
?>
--------------------------------------------------------------------------------

次ページからは、実際にAtomAPIを使ってはてなブックマークを操作してみます。POSTプロトコルを用いた新規ブックマークの追加処理と、PUTプロトコルを用いた既存ブックマークの変更処理について、サンプル・プログラムを作成して解説します。