bitly / Apiの概要

bitly apiについて

公式URL http://code.google.com/p/bitly-api/wiki/ApiDocumentation
当サイトでは、「API V3.0」を扱います。
認証・制限など API Key(2010/12/28時点)
概要 短縮URLサービス。
※OAuthもありますが省略しています。OAuthとして組み込むには、bitlyにメールを送信して認証を得る必要がありますが、一般的なアプリケーションを制作する場合OAuthにする必要性は少ないかと思います。

ここはなに?

bitlyの各種apiをコールしたときに、具体的にどんな値が返ってくるのか一瞬で分かります。
キーの意味を知るよりも、実際にどんな値が入っているかを知るほうが理解しやすいと思います。

目的の値を見つけて、あぁこの値を取り出すのはこのキーだな、とそんな使い方を想定しています。

bitlyの使い方

このページの下にあるapiの一覧から目的っぽいページに移動しましょう。
パラメータをセットして、「call update」と書かれたボタンを押します。

百聞は一見にしかずです。 短縮URLを作成に移動し、「call update」を押してみてください。

短縮URL

短縮URLを作成

短縮URLを作成します。

短縮URLから戻す

短縮URLから元のURLを取得します。

各種データを参照

ApiKeyを検証する

ログイン名とApiKeyの組み合わせに問題がないか確認します。

レスポンスの、data => valid を確認します。
0 : 正しくない
1 : 正しい

エンドユーザーのログイン名とApiKeyを預かって代理送信するアプリケーションを作る場面で使用します。

短縮URLのクリック数

指定した短縮URLがクリックされた回数を取得します。

短縮URLの参照元

指定した短縮URLがクリックされた参照元(短縮URLが貼られているページ)のURLを取得します。

短縮URLがクリックされた国

指定した短縮URLがクリックされた国の一覧を取得します。

1分あたりのクリック数

直近1時間で、指定した短縮URLがクリックされた回数を取得します。

1分ごとのクリック数の配列が返ります。

1日あたりのクリック数

指定した短縮URLが1日ごとにクリックされた回数を取得します。

過去30日分の、1日ごとのクリック数の配列が返ります。

登録されたドメインか確認

指定した短縮URLのドメインがbit.lyに割り当てられているか確認します。

bit.lyプロを使用すると、bit.ly以外の短縮URLのドメインを使うことができるようになります。
本apiでは、指定したドメインがbit.lyで登録されているか確認します。

たとえば、身近で代表的な短縮URLだと、foursquareの「4sq.com」があります。
4sq.comは、bit.lyの「expand」apiで伸張することができます。

長いURLから短縮URLを照会

長いURLを指定して、短縮URLを照会します。

パラメータのURLは複数指定できます。
下記のように、「url=」を複数回つなげて記述します。

短縮URLの詳細を取得

指定した短縮URLの作成者、URLのTitleタグなどの情報を取得します。