at backyard

Color my life with the chaos of trouble.

bitly APIをNode.jsから使う

bitly APIを使って短縮URLを作るために必要なもの

最近 bitlyAPIに触れたので、すぐ忘れる未来の自分のためにメモ

開発者用のドキュメントは下記

dev.bitly.com

ちなみに現在bitlyのAPIの最新バージョンはV4。
V3は2020年3月1日に使えなくなるようなので注意

bitlyのAPIを触るためには access token が必要になる
一番簡単と思われるaccess tokenの生成方法は、まずはbitlyのアカウントを作成し、ログイン後のダッシュボード内にあるgenerate access tokenというところからtokenを生成する方法となる。
このtokenを使ってAPIを叩くことになる。

利用ケースによっては他の生成方法もあるようだが、あまり凝った使い方を自分の場合はしなかったので、こちらはちゃんと調べていない
(token の生成についてはこちらに記述あり)

https://dev.bitly.com/v4/#section/OAuth-2

bitly APIをNode.jsを使って叩く

bitlyをnode.jsから叩く場合、npmライブラリを使って叩くのが最も簡単なやり方となる。

github.com

こちらは非公式なライブラリだが、Node.jsから叩くならこれがデファクトっぽいのと、ちゃんとメンテナンスもされているので、使うならこのライブラリが良さそう。
一応npmのページに行くと1週間で10000ダウンロードはされているようだった(2019/8時点)。

上にも書いたように、bitly APIはV4を使ったほうが良いので、v4に対応している 6.1.x 系 をインストールする必要がある。

インストール方法は下記の通り

# npm
npm install bitly@latest

# yarn
yarn add bitly@latest

使い方はgithub上のREADMEにわかりやすく書かれているので、そちらを参照。

注意点 (localhostは無効なURLとして処理されてしまう)

これは bitly を使う上ので注意点となるが、localhost のURLは短縮化しようとしてもINVALID_URIとして処理され500が返ってきてしまう。
ただ開発時やテストなどでどうしてもlocalhostを使いたいときは出てくるもの。
そういうときは127.0.0.1で指定すればOK。