Backlog APIをUbuntuから実行する

機会があってBacklog APIを実行する機会があったので、備忘のため残しておきます。

Backlog APIについては以下に記載があるのでこれを参考にしながら実行しました。
developer.nulab.com

目次

実施作業

準備

事前準備としてBacklogにログインし、個人設定からAPIキーを登録します。
登録ボタンを押下するとAPIキーが発行されるので、メモしておきます。

変数設定

環境はWindowsなのでWindows Terminalからubuntuを起動します。



以下のコマンドを実行して、APIキーとURLを変数に設定します。

$ api="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
$ user_url="https://[project名].backlog.com/api/v2/users?apiKey=$api"

コマンド実行

先ほど設定したURL変数を引数にcurlコマンドを実行します。

$ curl $user_url

モザイクかけていますが、ユーザ一覧が取得されます。



今回実行したユーザ一覧のAPIのレスポンスは公式の以下のページに記載されています。
developer.nulab.com


レスポンスはjsonなので、jqコマンドと組み合わせれば整形して出力することも可能です。

$ curl $user_url | jq

感想及び所感

今回はユーザ一覧を取得しましたが、以下URLから実行したいBacklog APIを検索して、URLの以下の部分を書き換えることで別のAPIも実行できます。
ただし、場合によっては管理者権限を求められたり、パラメータが必要だったりするので、そこは確認が必要です。

~/api/v2/users

developer.nulab.com