社長BLOG

APIを簡単にする方法

2011-12-19 (月)
社長BLOG
　手嶋守

APIはデベロッパーにとってのUIだ

エンドユーザーにとってのユーザーインターフェース（UI）とは、もちろん画面遷移やボタンの配置など、実際にエンドユーザーが操作するもの。

デベロッパーは直接画面を操作しない。彼らはAPIを通じて機能を作ったり、SNS本体を操作する。

そういう意味で、デベロッパーが直接操作するものは一般的なUIでは無くAPIなのだ。

そのデベロッパーのUIであるAPIをユーザーフレンドリーにして、簡単に使ってもらえるような仕掛けを考える。

URLを開くだけでとりあえず簡単に使える

初期のTwitterのAPIはとにかく感動した。これを入力するだけでAPIにアクセスできてしまった。

curl -u username:password -d status=”twittering from curl” http://twitter.com/statuses/update.xml

Twitterの初期、スタイリッシュなアプリやサービスが多く出てきて楽しかったのは、APIの操作が簡単だったというのが大きい。ヴィジュアル寄りのデベロッパーが、手軽に開発に参加できたからじゃないか。

※現在はBASIC認証が廃止されたので、以前に比べるとかなり難しくなっている。

HOUOUでは現在のところ、OpenPNEはスマートフォンAPIへのアクセスに、サイト内に埋め込まれたAPIKEYを利用する方式で進めている。OAuthよりも全然簡単だが、BASIC認証よりは難しい。

エラーメッセージを工夫して、
「あんたクッキー積んでアクセスしとるね。権限はあるんだけど呼び方が間違ってるよ、あなたのAPIKEYはXXXXXXXXXだから、今の方法じゃなくてこんなhttp://xxx.com/api/request?apikey=xxxxxxx&aaa=bbbbb でアクセスしてみてや、、、」

なんて、アドバイスをしてみるといいんじゃないかな？と思った。

全部のリクエストでやっていてもいけないので、curlコマンドや、通常のブラウザで直打ちをした場合には、丁寧な返答をしてあげるといい。