bit.ly APIに関する説明資料

bit.
ly API についての資料
bit.ly はデータを API を経由して公開しているので、開発者はプログラムから bit.ly の
ウェブサイトと連携できます。このドキュメントはそれら機能の公式レファレンスです。
API の現バージョンは 3.0 です。
目次
● 始めに
● 認証と共通引数
● リクエスト・レスポンス形式
● 利用制限
○ 高ボリューム利用者の方へ
● OAuth
○ OAuth Web Flow
○ OAuth XAuth Flow
● QR コード
● REST API
○ /v3/shorten
○ /v3/expand
○ /v3/validate
○ /v3/clicks
○ /v3/referrers
○ /v3/countries
○ /v3/clicks_by_minute
○ /v3/bitly_pro_domain
○ /v3/lookup
○ /v3/authenticate
○ /v3/info
○ /oauth/access_token
○ /v3/user/clicks
○ /v3/user/referrers
○ /v3/user/countries
○ /v3/user/realtime_links
本資料の原文は、http://orino.co/bwePRr (英語)でご覧になれます。
始めに
bit.ly の REST API ドキュメンテーションにて紹介されるトピックスは次の通りです。
認証と共通引数
1
bit.ly API documentation – revised 10/22/2010
日本語でのお問い合わせは Orinoco 株式会社まで：www.orinoco.jp / bitly@orinoco.jp
全ての API のエンドポイントは認証情報がクエリーの引数として指定されているのを必要とし
ています。
まず、無料の bit.ly アカウントと apiKey を作成する必要があります。次のリンクのページ
からアカウントを作成できます。http://bit.ly/a/sign_up
アカウント作成後 apiKey は次のページにて確認できま
す。http://bit.ly/a/your_api_key
login=login&apiKey=apiKey
注意：bitlyapidemo のアカウント情報及び apiKey はこのドキュメンテーションの中での
サンプルのためのみに表示しています。
リクエスト・レスポンス形式
全ての bit.ly
API はオプションのレスポンス形式引数が利用できます。デフォルトのレスポ
ンス形式は json ですが xml も提供しています。エンドポイントによっては txt 形式も利用
出来るものもあります。
format=json
全ての bit.ly
API では jsonp も利用できます。jsonp はコールバックが指定された json
形式です。例えば:
format=json&callback=callback_method
● 全ての API リクエストは api.bit.ly ドメインに対して行う必要があります(例で確
認してください)。
● json 及び xml 形式に対する正常なレスポンスの HTTP Response Status
Code は 200 です。 json 及び xml のレスポンスの場合は、status_code 及び
status_txt の値はリクエストが整形式かつ妥当で有ることを意味します。
● txt 形式のリクエストの場合 HTTP Response Status Code の 403、500 と
503 は利用制限の注意、リクエストのフォーマットの問題及び不明なエラーが有るこ
とを意味します。レスポンス本文は 200 レスポンス外の json 及び xml コールの
status_txt 部分と同等です。
● status_code は妥当なリクエストの場合は 200、利用制限の場合は 403、不明
なエラーか一時利用不可の場合は 503、その他の無効なリクエストやレスポンスの場
合は 500 です。
● status_txt は発生したエラーの内容を説明する値が表示されます。表示される頻
度が高い値は URL 引数が必要なときの MISSING_ARG_%s やリクエスト引数に
無効な値が含まれている場合の INVALID_%s 等があります（%s の部分にリクエ
スト引数の名前が表示されます）。
例：
2
● json { "status_code": 200, "status_txt": "OK", "data" : ... }
● json { "status_code": 403, "status_txt":
"RATE_LIMIT_EXCEEDED", "data" : null }
● json { "status_code": 500, "status_txt": "INVALID_URI", "data" :
null }
● json { "status_code": 500, "status_txt": "MISSING_ARG_LOGIN",
"data" : null }
● json { "status_code": 503, "status_txt": "UNKNOWN_ERROR",
"data" : null }
● jsonp callback_method({ "status_code": 200, "status_txt": "OK",
"data" : ... })
● xml
<?xml version="1.0" encoding="UTF-8"?>
<response>
<status_code>200</status_code>
<status_txt>OK</status_txt>
<data>
...
</data>
</response>
利用制限
現在 bit.ly は API の利用者に対して一つの IP アドレスからの同時接続数を５接続で制限して
います。さらに、各 API 毎に時間毎、分毎、そして IP アドレスごとの利用制限も設けていま
す。
利用制限はしていますが、デフォルトの制限はほとんどのサイトのニーズに十分対応出来る用
に設定されています。
API の利用制限は毎時間の始まり（００分）にリセットされます。利用制限によるエラーが発
生している場合は次の時間が始まるまでお待ちください。
利用制限による問題を回避するには API の利用に関する注意事項を確認ください。
高ボリューム利用者の方へ
もし bit.lyAPI の利用制限を超えるような高ボリュームの利用を推定される場合は
api@bit.ly までご連絡をしてください。
ご連絡の際に bit.ly API の利用方法、利用している、API エンドポイント及び、２４時間で
利用されたいボリュームもお伝え下さい。
3
OAuth¶
bit.ly は、OAuth 2 draft specification をサポートしています。全ての OAuth 2 リ
クエストは、 https://api-ssl.bit.ly/ にある SSL エンドポイントを利用しなくてはいけ
ません。
OAuth 2.0 はシンプルで、安全な認証の方法です。OAuth 2.0 をりようすることによ
り、ウェブのアプリケーションが、bit.ly サイトにリダイレクトする為に必要なアクセストー
クンを得る事が出来ます。アクセストークンを得た後、ユーザーのリンクに関する測定値や、
当該アカウントを利用した短縮 URL の生成ができます。OAuth による認証は、以下の方法
で出来ます。
OAuth Web Flow¶

以下の方法で、ウェブアプリケーションは、OAuth のアクセストークンを得る事が出来ま
す。
● まず、api@bit.ly（英語）にご連絡頂き、アプリケーションの登録アクセスを申請下
さい。（日本語で申請ご希望の場合は、bitly@orinoco.jp までご連絡下さい。）申
請終了後、お客様の bit.ly アカウントの「設定」(settings) メニューで、あなたの
アプリケーションを登録して下さい。登録後、client_id と client_secret が与え
られます。
● アクセストークンを入手後、client ID とリダイレクトを行いたいページを
client_id と redirect_uri parameters を使って転送し、ユーザーを
https://bit.ly/oauth/authorize にリダイレクトして下さい。リダイレクトの
URL の例は以下の通りです。https://bit.ly/oauth/authorize?
client_id=...&redirect_uri=http://myexamplewebapp.com/oauth_
page
● アプリケーションを認証後、ユーザーに redirect_uri パラメータで指定されたペー
ジが表示されます。”code”パラメータを URI に添付していますが、このパラメータ
は、下記の oauth/access_token エンドポイント資料を使う事で OAuth のアク
セストークンに変換される値を含んでいます。例えば、次の redirect_uri の値をパ
スした場合、http://myexamplewebapp.com/oauth_page,
認証が成功した場合、ユーザーを下記の URI に転送します。　
http://myexamplewebapp.com/oauth_page?code=....
● その前のリダイレクトに bit.ly によって添付された”code”値と、同様のその前に使
われた redirect_uri 値をパスする事により、下記の the
/oauth/access_token API エンドポイント資料を使って、OAUth のアクセス
トークンを入手する。API エンドポイントによって、OAuth アクセストークン、特
4
定された bit.ly ユーザーのログインと API キーが発行され、お客様のアプリケーショ
ンが、bit.ly の API を利用する事が可能となります。
OAuth XAuth Flow¶

OAuth web flow の利用が出来ないアプリケーション（例えば、ブラウザーレイヤーの無
いモバイルアプリ）に関しては、/oauth/access_token API エンドポイントに、ユー
ザーの bit.ly アカウント情報を x_auth_username と x_auth_password パラメー
タを使ってコールをかけて頂く事で、OAuth アクセストークンを入手する事が出来ます。
注：　ユーザーは、ユーザーネームとパスワードを一度だけ登録する必要がありま
す。XAuth を使ったアプリケーションは、決してユーザーのパスワードを保存しないで下さ
い。XAuth を利用した認証については、api＠bit.ly 宛にアクセスの申請を行って下さい。
（日本語で申請ご希望の場合は、bitly@orinoco.jp までご連絡下さい。）
QR コード¶
QR コードを作成するには、bit.ly のリンクの最後に .qrcode を添付して下さい。例えば
URL: http://bit.ly/3eI7.qrcode により、http://bit.ly/3eI7 の bit.ly にリンクす
る QR コードが作成されます。
5
REST API
/v3/shorten
長い URL に対して、 /v3/shorten は URL をエンコードして短縮 URL を返します。
引数
● format （オプション）レスポンスの形式を指定できます。サポートしている形式：
json（デフォルト）、 xml、 txt。
● longUrl 短縮される元の URL（例： http://betaworks.com/）。
● domain （オプション） bit.ly か j.mp ドメインを指定できます。出力される url
の値が変わります。
● x_login （オプション）その他の bit.ly ユーザーの代わりにリクエストをする場合
のそのユーザーのログイン情報です。これを利用することによりアプリケーション開
発者はそのユーザーの bit.ly ログイン情報を送ることが出来ます。
● x_apiKey （オプション）その他の bit.ly ユーザーの代わりにリクエストをする
場合に利用するそのユーザーの apiKey 情報です。これを利用することによりアプリ
ケーション開発者はそのユーザーの bit.ly apiKey 情報を送ることが出来ます。
注意
● 元の URL の URL エンコードをおすすめします。「&」、「?」、「#」、「」、
などの特定引数を含む URL は先に URL エンコードする必要があります。
● 空白を含む URL は利用できません：空白を含む元の URL は受け付けられません。全
ての空白は%20 もしくは+でエンコードする必要があります。タブ、改行、URL 後
の空白は全てエラーになります。URL 前後の空白を除いてから URL 短縮を行ってく
ださい。
● 元の URL はドメインとパスのあいだにスラッシュが必要です。例え
ば、http://example.com?query=parameter はエラーになりますの
で、http://example.com/?query=parameter 形式に先に変換擦る必
要があります。
● x_login と x_apiKey が指定されている場合は、x_login で指定されているユー
ザーの履歴に短縮 URL が追加されます。login で指定されているユーザーの履歴には
追加されません。
出力
● new_hash は元 URL が初めて短縮されたことを表します。戻り値が 1 の場
合、long_url が初めて短縮された事を表します。ユーザーの履歴にも追加されま
す。
● url 　は実際使用するべきの link です。この値は、各 bit.ly アカウント毎の独特な
値です。
● hash は long_url に対する bit.ly の識別値で、各アカウント毎の独特な値です。
6
● global_hash は long_url に対する hash を全て統括する bit.ly の識別値であ
り、それに対する全ての bit.ly リンクの統計を表示するために使用できます。
● long_url は longUrl リクエスト引数のエコーです。必ずしも元の URL と同じだ
とは限りません。long_url はリクエスト引数とは機能的には同等です。
例
● json 形式 http://api.bit.ly/v3/shorten?
login=bitlyapidemo&apiKey=R_0da49e0a9118ff35f52f629d2d71b
f07&longUrl=http%3A%2F%2Fbetaworks.com%2F&format=json
{
"status_code": 200,
"data": {
"url": "http://bit.ly/cmeH01",
"hash": "cmeH01",
"global_hash": "1YKMfY",
"long_url": "http://betaworks.com/",
"new_hash": 0
},
"status_txt": "OK"
}
● xml 形式 http://api.bit.ly/v3/shorten?
f07&longUrl=http%3A%2F%2Fbetaworks.com%2F&format=xml
<response>
<data>
<url>http://bit.ly/cmeH01</url>
<hash>cmeH01</hash>
<global_hash>1YKMfY</global_hash>
<long_url>http://betaworks.com/</long_url>
<new_hash>0</new_hash>
</data>
</response>
7
● txt 形式 http://api.bit.ly/v3/shorten?
f07&longUrl=http%3A%2F%2Fbetaworks.com%2F&format=txt
http://bit.ly/cmeH01
/v3/expand
bit.ly URL や hash(複数も可)を渡せば /v3/expand はデコードしてターゲット URL を
返します。
引数
● format （オプション）レスポンスの形式を指定できます。サポートしている形式：
json（デフォルト）、 xml、 txt。
● shortUrl は一つもしくは複数の bit.ly URL です、（例：
http://bit.ly/1RmnUT か http://j.mp/1RmnUT）。
● hash は一つもしくは複数の bit.ly hash です、（例： 2bYgqR かカスタム
名）。
注意
● shortUrl も hash も引数としてリクエストされる必要があります。
● shortURL 及び hash 引数の最高数は１５です。
出力
● short_url shortUrl リクエスト引数のエコーです。
● hash は hash リクエスト引数のエコーです。
● user_hash 関連する bit.ly ユーザー ID。
● global_hash 元 URL に対する bit.ly の統括 hash の ID。
● error 特定の shortUrl もしくは hash に対するデータを取得においてエラーが生
じた事を意味します。エラーの例は「NOT_FOUND」。
● long_url は short_url もしくは hash が指定しているターゲット URL です。
例
● json 形式 http://api.bit.ly/v3/expand?shortUrl=http%3A%2F
%2Ftcrn.ch%2Fa4MSUH&shortUrl=http%3A%2F%2Fbit.ly
%2F1YKMfY&login=bitlyapidemo&apiKey=R_0da49e0a9118ff35f5
2f629d2d71bf07&hash=j3&hash=a35.&format=json
{
"status_code": 200,
8
"data": {
"expand": [
{
"short_url": "http://tcrn.ch/a4MSUH",
"global_hash": "bWw49z",
"long_url":
"http://www.techcrunch.com/2010/01/29/windows-mobile-
foursquare/",
"user_hash": "a4MSUH"
},
{
"short_url": "http://bit.ly/1YKMfY",
"long_url": "http://betaworks.com/",
"user_hash": "1YKMfY"
},
{
"long_url": "http://www.scotster.com/qf/?1152",
"global_hash": "lLWr",
"hash": "j3",
"user_hash": "j3"
},
{
"hash": "a35.",
"error": "NOT_FOUND"
}
]
},
"status_txt": "OK"
}
● xml 形式 http://api.bit.ly/v3/expand?shortUrl=http%3A%2F
2f629d2d71bf07&hash=j3&hash=a35.&format=xml
9
<response>
<data>
<entry>
<short_url>http://tcrn.ch/a4MSUH</short_url>

<long_url>http://www.techcrunch.com/2010/01/29/windows-
mobile-foursquare/</long_url>
<user_hash>a4MSUH</user_hash>
<global_hash>bWw49z</global_hash>
</entry>
<entry>
<short_url>http://bit.ly/1YKMfY</short_url>
<long_url>http://betaworks.com/</long_url>
<user_hash>1YKMfY</user_hash>
</entry>
<entry>
<hash>j3</hash>
<long_url>http://www.scotster.com/qf/?
1152</long_url>
<user_hash>j3</user_hash>
<global_hash>lLWr</global_hash>
</entry>
<entry>
<error>NOT_FOUND</error>
<hash>a35.</hash>
</entry>
</data>
</response>
● json 形式 http://api.bit.ly/v3/expand?shortUrl=http%3A%2F
%2Fbit.ly
10
%2F31IqMl&login=bitlyapidemo&apiKey=R_0da49e0a9118ff35f5
2f629d2d71bf07&format=json
{
"status_code": 200,
"data": {
"expand": [
{
"short_url": "http://bit.ly/31IqMl",
"global_hash": "31IqMl",
"long_url": "http://cnn.com/",
"user_hash": "31IqMl"
}
]
},
"status_txt": "OK"
}
● xml 形式 http://api.bit.ly/v3/expand?shortUrl=http%3A%2F
%2Fbit.ly
2f629d2d71bf07&format=xml
<response>
<data>
<entry>
<short_url>http://bit.ly/31IqMl</short_url>
<long_url>http://cnn.com/</long_url>
<user_hash>31IqMl</user_hash>
<global_hash>31IqMl</global_hash>
</entry>
</data>
</response>
● txt 形式 http://api.bit.ly/v3/expand?shortUrl=http%3A%2F
%2Fbit.ly
11
2f629d2d71bf07&format=txt
http://cnn.com/
/v3/validate
bit.ly のユーザーログインと apiKey に対して、そのペアが現在有効かどうかを確認できま
す。
引数
● format （オプション）レスポンスの形式を指定できます。サポートしている形
式： json（デフォルト）、 xml、 txt。
● x_login ユーザーの bit.ly ログイン ID（認証用）。
● x_apiKey ユーザーの bit.ly apiKey（認証用）。
出力
● valid 0 か 1 の値により、x_login と x_apiKey のペアが現在有効かどうかが示さ
れます。
例
● json 形式 http://api.bit.ly/v3/validate?
x_login=notbilytapi&x_apiKey=not_apikey&apiKey=R_0da49e0a9
118ff35f52f629d2d71bf07&login=bitlyapidemo&format=json
{
"status_code": 200,
"data": {
"valid": 0
},
"status_txt": "OK"
}
● xml 形式 http://api.bit.ly/v3/validate?
118ff35f52f629d2d71bf07&login=bitlyapidemo&format=xml
<response>
<data>
<valid>0</valid>
12
</data>
</response>
● txt 形式 http://api.bit.ly/v3/validate?
118ff35f52f629d2d71bf07&login=bitlyapidemo&format=txt
0
/v3/clicks
一つもしくは複数の bit.ly URL 及び hash に対して、そのリンクに対するクリックの統計を
呼び出せます。
引数
● format （オプション）　レスポンスの形式を指定できます。サポートしている形
式：json（デフォルト）、 xml。
名）。
注意
出力
● user_clicks 指定されたユーザーの bit.ly リンクへのクリック総数です。
● global_clicks 元の URL に対しての bit.ly リンク全体のクリック総数です。
例
● json 形式 http://api.bit.ly/v3/clicks?shortUrl=http%3A%2F
2f629d2d71bf07&hash=j3&hash=a35.&format=json
13
{
"status_code": 200,
"data": {
"clicks": [
{
"user_clicks": 0,
"user_hash": "a4MSUH",
"global_clicks": 1105
},
{
"user_clicks": 2218,
"user_hash": "1YKMfY",
},
{
"hash": "j3",
"user_clicks": 105,
"user_hash": "j3",
},
{
"hash": "a35.",
"error": "NOT_FOUND"
}
]
},
"status_txt": "OK"
}
● xml 形式 http://api.bit.ly/v3/clicks?shortUrl=http%3A%2F
14
2f629d2d71bf07&hash=j3&hash=a35.&format=xml
<response>
<data>
<clicks>
<user_clicks>0</user_clicks>
<global_clicks>1105</global_clicks>
</clicks>
<clicks>
</clicks>
<clicks>
<hash>j3</hash>
</clicks>
<clicks>
<hash>a35.</hash>
</clicks>
</data>
</response>
15
/v3/referrers¶
特定の bit.ly 短縮 URL に対してのリファラーサイトと、リファラーあたりのクリック数に関
するデータを提供します。
パラメータ
● format (optional) リクエストの回答フォーマット. 現状サポートされている
フォーマットは jason と xml になります。
● shortUrl は bit.ly の短縮 URL を意味します。 (e.g.:
http://bit.ly/1RmnUT or http://j.mp/1RmnUT).
● hash は bit.ly のハッシュ以下の文字列を意味します。(e.g.: 2bYgqR もしくは
カスタムの名前).
Note
● shortUrl もしくは hash がパラメータとして指定される必要があります。
● この API エンドポイントは、API コールひとつあたり、ひとつの bit.ly 短縮 URL
のデータしか返しません。
アウトプット
● short_url これは、shortUrl リクエストパラメータと合致します。
● hash hash リクエストパラメータと合致します。
● user_hash は bit.ly のユーザーを特定するものです。
● referrer は、bit.ly 短縮 URL に対するリファラーサイトです。
● referrer_app は、ある特定の bit.ly 短縮 URL に対するリファラーとなっている
アプリケーション（例： Tweetdeck）です。
● url リファラーとなっているアプリケーションの URL です。 (例：
http://tweetdeck.com).
● clicks はリファラーに対するクリック数です。
例
● json フォーマット http://api.bit.ly/v3/referrers?shortUrl=http%3A
%2F%2Fbit.ly
%2FdjZ9g4&login=bitlyapidemo&apiKey=R_0da49e0a9118ff35f5
{
"data": {
"created_by": "bitly",
"global_hash": "djZ9g4",
"referrers": [
16
{
"clicks": 42,
"referrer": "direct"
},
{
"clicks": 15,
"referrer": "http://twitter.com/"
},
{
"clicks": 12,
"referrer": "http://twitter.com/bitly"
},
{
"clicks": 8,
"referrer_app": "TweetDeck",
"url": "http://www.tweetdeck.com/"
},
{
"clicks": 1,
"referrer": "http://bit.ly/a/sidebar"
},
{
"clicks": 1,
"referrer":
"http://translate.googleusercontent.com/translate_c"
},
{
"clicks": 1,
"referrer":
"http://twitter.com/atul/statuses/26029156685"
},
{
"clicks": 1,
"referrer": "http://twitter.com/home"
},
17
{
"clicks": 1,
"referrer": "http://untiny.me/"
}
],
"short_url": "http://bit.ly/djZ9g4",
"user_hash": "djZ9g4"
},
"status_code": 200,
"status_txt": "OK"
}
● xml フォーマット http://api.bit.ly/v3/referrers?shortUrl=http%3A
%2F%2Fbit.ly
<response>
<data>
<short_url>http://bit.ly/djZ9g4</short_url>
<global_hash>djZ9g4</global_hash>
<user_hash>djZ9g4</user_hash>
<created_by>bitly</created_by>
<referrers>
<referrer>direct</referrer>
<clicks>42</clicks>
</referrers>
<referrers>
<referrer>http://twitter.com/</referrer>
<clicks>15</clicks>
</referrers>
<referrers>
<referrer>http://twitter.com/bitly</referrer>
<clicks>12</clicks>
</referrers>
18
<referrers>
<url>http://www.tweetdeck.com/</url>
<referrer_app>TweetDeck</referrer_app>
<clicks>8</clicks>
</referrers>
<referrers>
<referrer>http://bit.ly/a/sidebar</referrer>
<clicks>1</clicks>
</referrers>
<referrers>

<referrer>http://translate.googleusercontent.com/translate_c</r
eferrer>
<clicks>1</clicks>
</referrers>
<referrers>

<referrer>http://twitter.com/atul/statuses/26029156685</referr
er>
<clicks>1</clicks>
</referrers>
<referrers>
<referrer>http://twitter.com/home</referrer>
<clicks>1</clicks>
</referrers>
<referrers>
<referrer>http://untiny.me/</referrer>
<clicks>1</clicks>
</referrers>
</data>
</response>
/v3/countries¶
19
bit.ly 短縮 URL のクリックが発生した国名と、国ごとのクリック数に関するデータを提供し
ます。
パラメータ
カスタムの名前)。
Note
● Either shortUrl or hash must be given as a parameter.
● This API endpoint can only provide data for one bit.ly short link
per API call.
アウトプット
● countries bit.ly の短縮 URL に関するクリックが発生された国の一覧です。
● clicks は、各国から発生したクリックの数です。
例
● json フォーマット http://api.bit.ly/v3/countries?shortUrl=http%3A
%2F%2Fbit.ly
{
"data": {
"countries": [
{"clicks": 40, "country": "US"},
{"clicks": 7,"country": null},
{"clicks": 4,"country": "AU"},
{"clicks": 4,"country": "BR"},
{"clicks": 4,"country": "FR"},
{"clicks": 3,"country": "CA"},
20
{"clicks": 3,"country": "GB"},
{"clicks": 2,"country": "DE"},
{"clicks": 2,"country": "IN"},
{"clicks": 2,"country": "NO"},
{"clicks": 2,"country": "PL"},
{"clicks": 2,"country": "TW"},
{"clicks": 1,"country": "BE"},
{"clicks": 1,"country": "BG"},
{"clicks": 1,"country": "ES"},
{"clicks": 1,"country": "HK"},
{"clicks": 1,"country": "PH"},
{"clicks": 1,"country": "PT"},
{"clicks": 1,"country": "SE"},
{"clicks": 1,"country": "VE"}
],
"global_hash": "djZ9g4",
"short_url": "http://bit.ly/djZ9g4",
"user_hash": "djZ9g4"
},
"status_code": 200,
"status_txt": "OK"
}
● xml フォーマット http://api.bit.ly/v3/countries?shortUrl=http%3A
%2F%2Fbit.ly
<response>
<data>
<short_url>http://bit.ly/djZ9g4</short_url>
<global_hash>djZ9g4</global_hash>
<user_hash>djZ9g4</user_hash>
21

<countries><country>US</country><clicks>40</clicks></coun
tries>
<countries><country/><clicks>7</clicks></countries>

<countries><country>AU</country><clicks>4</clicks></countr
ies>

<countries><country>BR</country><clicks>4</clicks></countr
ies>

<countries><country>FR</country><clicks>4</clicks></countr
ies>

<countries><country>CA</country><clicks>3</clicks></countr
ies>

<countries><country>GB</country><clicks>3</clicks></countr
ies>

<countries><country>DE</country><clicks>2</clicks></countr
ies>

<countries><country>IN</country><clicks>2</clicks></countri
es>

<countries><country>NO</country><clicks>2</clicks></countr
ies>

<countries><country>PL</country><clicks>2</clicks></countri
es>

<countries><country>TW</country><clicks>2</clicks></count
ries>

22
<countries><country>BE</country><clicks>1</clicks></countr
ies>

<countries><country>BG</country><clicks>1</clicks></countr
ies>

<countries><country>ES</country><clicks>1</clicks></countr
ies>

<countries><country>HK</country><clicks>1</clicks></countr
ies>

<countries><country>PH</country><clicks>1</clicks></countr
ies>

<countries><country>PT</country><clicks>1</clicks></countri
es>

<countries><country>SE</country><clicks>1</clicks></countr
ies>

<countries><country>VE</country><clicks>1</clicks></countr
ies>
</data>
</response>
/v3/clicks_by_minute¶
１つ以上の bit.ly 短縮 URL に対して、最後の一時間の分刻みのデータを提供します。（最新
の時間から順番となります）
パラメータ
23
カスタムの名前).
Note
● shortUrl もしくは hash がパラメータとして指定される必要があります。
● shortUrl と hash がパラメータの最大数は１５です。
アウトプット
● clicks は、特定の bit.ly 短縮 URL に対する分ごとのクリック数です。
例
● json フォーマット http://api.bit.ly/v3/clicks_by_minute?
shortUrl=http%3A%2F%2Fj.mp
%2F9DguyN&login=bitlyapidemo&apiKey=R_0da49e0a9118ff35f
{
"data": {
"clicks_by_minute": [
{
"clicks":
[0,0,0,0,2,2,4,3,1,0,1,0,2,0,0,0,1,1,0,0,2,1,1,3,1,2,1,1,0,1,1,0,1
,1,1,0,1,1,1,0,2,3,1,1,3,2,0,3,3,2,2,1,3,3,2,1,0,4,0,2,1],
"global_hash": "9DguyN",
"short_url": "http://j.mp/9DguyN",
"user_hash": "9DguyN"
}
]
},
"status_code": 200,
"status_txt": "OK"
}
● xml フォーマット http://api.bit.ly/v3/clicks_by_minute?
shortUrl=http%3A%2F%2Fj.mp
24
%2F9DguyN&login=bitlyapidemo&apiKey=R_0da49e0a9118ff35f
<response>
<data>
<clicks_by_minute>
<short_url>http://j.mp/9DguyN</short_url>
<global_hash>9DguyN</global_hash>
<user_hash>9DguyN</user_hash>
<clicks>0</clicks>
<clicks>0</clicks>
<clicks>0</clicks>
<clicks>0</clicks>
<clicks>2</clicks>
<clicks>2</clicks>
<clicks>4</clicks>
<clicks>3</clicks>
<clicks>1</clicks>
<clicks>0</clicks>
<clicks>1</clicks>
<clicks>0</clicks>
<clicks>2</clicks>
<clicks>0</clicks>
<clicks>0</clicks>
<clicks>0</clicks>
<clicks>1</clicks>
<clicks>1</clicks>
<clicks>0</clicks>
<clicks>0</clicks>
<clicks>2</clicks>
<clicks>1</clicks>
<clicks>1</clicks>
<clicks>3</clicks>
<clicks>1</clicks>
25
<clicks>2</clicks>
<clicks>1</clicks>
<clicks>1</clicks>
<clicks>0</clicks>
<clicks>1</clicks>
<clicks>1</clicks>
<clicks>0</clicks>
<clicks>1</clicks>
<clicks>1</clicks>
<clicks>1</clicks>
<clicks>0</clicks>
<clicks>1</clicks>
<clicks>1</clicks>
<clicks>1</clicks>
<clicks>0</clicks>
<clicks>2</clicks>
<clicks>3</clicks>
<clicks>1</clicks>
<clicks>1</clicks>
<clicks>3</clicks>
<clicks>2</clicks>
<clicks>0</clicks>
<clicks>3</clicks>
<clicks>3</clicks>
<clicks>2</clicks>
<clicks>2</clicks>
<clicks>1</clicks>
<clicks>3</clicks>
<clicks>3</clicks>
<clicks>2</clicks>
<clicks>1</clicks>
<clicks>0</clicks>
<clicks>4</clicks>
<clicks>0</clicks>
<clicks>2</clicks>
26
<clicks>1</clicks>
</clicks_by_minute>
</data>
</response>
/v3/bitly_pro_domain
このクエリーでは特定のショートドメインが bitly.Pro 用にすで登録されているかを確認でき
ます、このクエリーを用いてその他 api コール用に有効な shortUrl 引数かどうかを確認でき
ます。尚、bitly.Pro のドメインは１４文字以内に制限されています。
引数
● domain ショートドメイン（nyti.ms 等）。
式： json（デフォルト）、 xml。
出力
● bitly_pro_domain 0 か 1 で現在 bitly.Pro のドメインか示されます。
● domain リクエスト引数のエコーです。
例
● json 形式 http://api.bit.ly/v3/bitly_pro_domain?
domain=nyti.ms&apiKey=R_0da49e0a9118ff35f52f629d2d71bf07
&login=bitlyapidemo&format=json
{
"status_code": 200,
"data": {
"domain": "nyti.ms",
"bitly_pro_domain": 1
},
"status_txt": "OK"
}
● xml 形式 http://api.bit.ly/v3/bitly_pro_domain?
domain=nyti.ms&apiKey=R_0da49e0a9118ff35f52f629d2d71bf07
&login=bitlyapidemo&format=xml
<response>
27
<data>
<domain>nyti.ms</domain>
<bitly_pro_domain>1</bitly_pro_domain>
</data>
</response>
/v3/lookup
特定の元 URL に対する bit.ly リンクをクエリーするために使用できます。例えば特定の元
UR ｌから/v3/lookup のあとに/v3/clicks を利用してクリックデータ等を引き出せま
す。
引数
● url 一つもしくは複数の元 URL
注意
● url 引数の上限は 15 です。
出力
● url url 引数のエコー。
● short_url 関連 bit.ly 短縮リンク。
例
● json 形式 http://api.bit.ly/v3/lookup?url=http%3A%2F
%2Fbetaworks.com%2F&url=http%3A%2F%2Fcode.google.com
%2Fp%2Fbitly-api
%2F&login=bitlyapidemo&apiKey=R_0da49e0a9118ff35f52f629d
2d71bf07&format=json
{
"data": {
"lookup": [
{
"global_hash": "beta",
"short_url": "http://bit.ly/beta",
"url": "http://betaworks.com/"
},
28
{
"global_hash": "1oDCU",
"short_url": "http://bit.ly/1oDCU",
"url": "http://code.google.com/p/bitly-api/"
}
]
},
"status_code": 200,
"status_txt": "OK"
}
● xml 形式 http://api.bit.ly/v3/lookup?url=http%3A%2F
%2Fbetaworks.com%2F&url=http%3A%2F%2Fcode.google.com
%2Fp%2Fbitly-api
%2F&login=bitlyapidemo&apiKey=R_0da49e0a9118ff35f52f629d
2d71bf07&format=xml
<response>
<data>
<lookup>
<url>http://betaworks.com/</url>
<short_url>http://bit.ly/beta</short_url>
<global_hash>beta</global_hash>
</lookup>
<lookup>
<url>http://code.google.com/p/bitly-api/</url>
<short_url>http://bit.ly/1oDCU</short_url>
<global_hash>1oDCU</global_hash>
</lookup>
</data>
</response>
● json 形式 http://api.bit.ly/v3/lookup?url=asdf%3A%2F
%2Fwww.google.com%2Fnot%2Fa%2Freal
29
%2Flink&login=bitlyapidemo&apiKey=R_0da49e0a9118ff35f52f6
29d2d71bf07&format=json
{
"data": {
"lookup": [
{
"error": "NOT_FOUND",
"url": "asdf://www.google.com/not/a/real/link"
}
]
},
"status_code": 200,
"status_txt": "OK"
}
● xml 形式 http://api.bit.ly/v3/lookup?url=asdf%3A%2F
%2Fwww.google.com%2Fnot%2Fa%2Freal
%2Flink&login=bitlyapidemo&apiKey=R_0da49e0a9118ff35f52f6
29d2d71bf07&format=xml
<response>
<data>
<lookup>
<url>asdf://www.google.com/not/a/real/link</url>
</lookup>
</data>
</response>
/v3/authenticate
特定のユーザーの bit.ly ユーザー名及びパスワードを元に bit.ly API key を探し出すため
に利用できます。
30
このエンドポイントへのアクセスは制限されており、アクセスのリクエストは　api@bit.ly
宛にメールする必要があります。アクセスをリクエストする際には、アプリケーションのログ
イン ID 及び apiKey、利用方法、そしてリクエストの想定ボリュームも一緒にお送りくださ
い。
引数
● x_login ユーザーの bit.ly ユーザー名もしくはメールアドレス。
● x_password ユーザーの bit.ly パスワード。
注意
● このリクエストは HTTP POST しか使えません、HTTP GET のリクエストは受け
付けていません。
出力
● successful はログイン・パスワードの組み合わせが有効かどうかを表示します。
● username は指定された bit.ly ユーザーのユーザー名です。
● api_key は指定された bit.ly ユーザーの apiKey です。
例
● json 形式 http://api.bit.ly/v3/authenticate
POST: x_login=bitlyapidemo&x_password=bad-
password&apiKey=R_0da49e0a9118ff35f52f629d2d71bf07&login=bitly
apidemo&format=json
{
"data": {
"authenticate": {
"successful": false
}
},
"status_code": 200,
"status_txt": "OK"
}
● xml 形式 http://api.bit.ly/v3/authenticate
POST: x_login=bitlyapidemo&x_password=bad-
apidemo&format=xml
<response>
31
<data>
<authenticate>
<successful>0</successful>
</authenticate>
</data>
</response>
● json 形式 http://api.bit.ly/v3/authenticate
POST: x_login=bitlyapidemo&x_password=good-
apidemo&format=json
{
"data": {
"authenticate": {
"api_key": "R_0da49e0a9118ff35f52f629d2d71bf07",
"successful": true,
"username": "bitlyapidemo"
}
},
"status_code": 200,
"status_txt": "OK"
}
● xml 形式 http://api.bit.ly/v3/authenticate
POST: x_login=bitlyapidemo&x_password=good-
apidemo&format=xml
<response>
<data>
<authenticate>
<username>bitlyapidemo</username>
<successful>1</successful>
<api_key>R_0da49e0a9118ff35f52f629d2d71bf07</api_key>
32
</authenticate>
</data>
</response>
/v3/info
特定の bit.ly リンクのページタイトルを引き出すために使用します。
引数
● format （オプション）レスポンスの形式を指定できます。サポートしている形
式： json（デフォルト）、 xml、 txt。
名）。
注意
出力
● title リンク先ページの HTML page title （存在する場合）。
● created_by この link を最初に短縮した bit.ly のユーザー名
例
● json 形式 http://api.bit.ly/v3/info?shortUrl=http%3A%2F
2f629d2d71bf07&hash=j3&hash=a.35&format=json
{
"data": {
"info": [
33
{
"created_by": "scotster",
"hash": "j3",
"title": null,
"user_hash": "j3"
},
{
"error": "NOT_FOUND",
"hash": "a.35"
},
{
"created_by": "j3h14h",
"title": "Windows Mobile Finally Checks Out
Foursquare",
"user_hash": "a4MSUH"
},
{
"title": null,
"user_hash": "1YKMfY"
}
]
},
"status_code": 200,
"status_txt": "OK"
}
● xml 形式 http://api.bit.ly/v3/info?shortUrl=http%3A%2F
2f629d2d71bf07&hash=j3&hash=a.35&format=xml
34
<response>
<data>
<info>
<hash>j3</hash>
<created_by>scotster</created_by>
<title/>
</info>
<info>
<hash>a.35</hash>
</info>
<info>
<created_by>j3h14h</created_by>
<title>Windows Mobile Finally Checks Out
Foursquare</title>
</info>
<info>
<title/>
</info>
</data>
</response>
/oauth/access_token¶
35
このエンドポイントで、OAuth アクセストークンを入手出来ます。OAuth アプリケーショ
ンを登録するには、api@bit.ly（英語）もしくは、bitly@orinoco.jp（日本語）へご連絡
下さい。
OAuth Web flow のパラメータ

● client_id あなたのアプリケーションの bit.ly client id です。
● client_secret は、あなたのアプリケーションの bit.ly client secret です。
● code は、OAuth のウェブ認証プロトコールによって獲得された OAuth 認証コー
ドです。
● redirect_uri は、ユーザーが認証後にリダイレクトされたページの URL です。
OAuth XAuth のパラメータ
● client_id あなたのアプリケーションの bit.ly client id です。
● client_secret は、あなたのアプリケーションの bit.ly client secret です。
● x_auth_username は、XAuth 認証のみのエンドユーザーの bit.ly ユーザー
名です。
● x_auth_password は、XAuth 認証のみのエンドユーザーの bit.ly パスワー
ドです。
Note
● HTTP POST リクエストである必要があります。
● このエンドポイントは、こちらの URL からのみアクセスかのうです。https://api-
ssl.bit.ly/
● x_auth_username と x_auth_password は、ウェブでのリダイレクトが出
来なかった時にのみ使われます。（例えば、ブラウザーレイヤーの無いモバイルアプ
リ）
● 注：XAuth を利用した認証については、api＠bit.ly 宛にアクセスの申請を行って下
さい。（日本語で申請ご希望の場合は、bitly@orinoco.jp までご連絡下さい。）
アウトプット
access_token=%s&login=%s&apiKey=%s フォーマットで URL エンコードされ
たストリング
● access_token は、特定のユーザーへの OAuth アクセストークン
● login は、エンドユーザーの bit.ly ユーザー名
● apiKey は、エンドユーザーの bit.ly API キー
/v3/user/clicks¶
一日あたりのユーザーの bit.ly 短縮 URL に関するトータルのクリック数を提供する OAuth
2 エンドポイントです。
パラメータ
36
● days (optional) さかのぼってデータを取得する日数の整数(最新から逆算で) (最
小:1, 最大:30, でフォルト:7)。
● format (optional) はリクエストされたレスポンスのフォーマットです。サポート
されているフォーマットは、json (default)と xml になります。
注
● このエンドポイントは、 https://api-ssl.bit.ly/ でのみ利用可能です
● 結果は最新から順に返されます。
アウトプット
● clicks その日のトータルのクリック数です。
/v3/user/referrers¶
特定のユーザーの bit.ly 短縮 URL に対してのトップリファラー（最大１日５００件）と、リ
ファラーあたりのクリック数に関するデータを提供する OAuth 2 エンドポイントです。
パラメータ
小:1, 最大:30, でフォルト:7)。
注
アウトプット
● referrers 最大５００件とする、その日のトップリファラーのリスト
● clicks その日の特定のリファラーに対するクリック数
/v3/user/countries¶
bit.ly ユーザーの短縮 URL へののクリックが発生した国名と、国ごとのクリック数に関する
データを提供する OAuth 2 のエンドポイントです。
パラメータ
小:1, 最大:30, でフォルト:7)。
37
注
アウトプット
● countries bit.ly の短縮 URL に関するクリックが発生された国の一覧です。
● clicks は、各国から発生したクリックの数です。
/v3/user/realtime_links¶
過去１時間のトラフィックやリンクに対するクリック数によって、あるユーザーの最も人気の
１００のリンクを提供する OAuth2 エンドポイント。
パラメータ
小:1, 最大:30, でフォルト:7)。
注
● このエンドポイントは最大１００件の結果を返します。
アウトプット
● clicks は、過去１時間のクリック数です。
● user_hash は、対応する bit.ly user link identifier です。
38

bit.ly APIに関する説明資料

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

bit.ly APIに関する説明資料

Uploaded by

Copyright:

Available Formats

bit.

OAuth Web Flow¶

OAuth XAuth Flow¶

OAuth Web flow のパラメータ

You might also like