APIとは
APIとはBelugaのWebサイトへアクセスしなくても、Belugaの一部機能を実行できる機能です。
Belugaとマッシュアップしたいプログラムを作成するときにつかえます。
例）TwitterクライアントでBelugaへ同時投稿など。
APIの使い方
APIを利用する場合、アプリケーションをBelugaに登録します。
また、利用者は登録したアプリの認証をして、トークンを取得します。
発行されたトークンは、APIを実行するときに使います。
再度認証した場合、過去のトークンは無効になるので、トークンを盗まれてもアカウントの乗っ取りなどの影響はありません。
なお、APIはHTTPが叩けるものであれば、何でも利用可能です。
API利用基本的な流れ アプリ登録→認証URLへアクセス→ユーザー認証→トークン取得→API実行
アプリケーションの登録
開発者用のページへアクセスし、右上のメニューからログインします。
次に、同じメニューから、新規作成を選びアプリケーションの登録を行います。
項目の説明
- 名前（必須）
投稿時に表示されるアプリケーション名です
- 説明（必須）
アプリケーションの説明です。
- ウェブサイト
投稿時に表示されるアプリ名をクリックした時にはられるLinkです。
実はJavaScriptを指定することも可能。 - コールバックURL
認証後、”指定したURL＋?user_id=xxxx&user_token=xxxx”にリダイレクトされます。
URLにはアプリケーションを指定しましょう。アプリは、パラメータ取得でuser_id,user_tokenを取得して、これらをAPIを叩くときに使用します。（IphonやandroidだとURLスキーマを使うと良い）
この値が空白だとuser_idとuser_tokenの取得フォームが表示されます。
上記の操作が困難な場合はユーザーにコピペするように指示しましょう。
作成後にアプリを認証するURLと、app_idとapp_secretが表示されます。
API通信時には、app_id,app_secret,user_id,user_tokenを利用します。
認証は一度だけし、それ以降はCookieやユーザーストレージに保存しておくと便利です。botなどのプログラムの場合は、認証を前もって行い。app_id,app_secret,user_id,user_tokenをアプリ内で静的に定義しておくと便利です。
APIリファレンス
すべてのAPIはHTTP/GETで取得し、戻り値はJSONです。
必須パラメータ:app_id,app_secret,user_id,user_token
text,room_hashはURLエンコード必須です
取得系
投稿系
その他
テンプレ
- 1/template API機能説明のテンプレート これをベースに使ってください
APIの例
ホーム一覧を取得する例（app_idがhoge1、app_secretがhoge2、user_idがoppai1、user_tokenがoppai2のとき）
http://api.beluga.fm/1/statuses/home?app_id=hoge1&app_secret=hoge2&user_id=oppai1&user_token=oppai2&since_id=0