PythonでBacklog APIを利用するまで
仕事でBacklogを使用しており、今後Backlog APIを使うので導入方法をまとめておきます。
Backlog APIとは？
課題,Wiki,ファイルの追加や取得を始め、プロジェクトやユーザーの管理などブラウザ上のBacklogでできる操作の大部分をAPIから行うことができます。詳しくはAPI リストを参照してください。 また、Cross Origin Resource Sharing (CORS) によるブラウザ上でのAjaxを使用したクロスドメイン通信が可能です。
認証方法について
今回、バックエンド処理でBacklogから情報を取得することを想定して、API Key方式で利用します。
API Keyを取得する
Backlogにログインし、アカウント設定画面を開きます。
メニューのAPIをクリックします。
メモを適当に入力します。アプリ名や用途など記載しておくといいでしょう。
登録ボタンをクリックしたら一覧にAPIキーが追加されますので、コピーしておきましょう。
Backlogから情報を取得する
pythonでBacklogからユーザ情報を取得します。
import requests BACKLOG_HOST = '〜' # BacklogのURL BACKLOG_API_KEY = '〜' # 取得したAPI Key def main(): params = {'apiKey': BACKLOG_API_KEY} r = requests.get(BACKLOG_HOST + '/api/v2/users/myself', params=params) print(r.json()) if __name__ == '__main__': main()
カンタンですね。他にもたくさんの受け口があるので、Backlog APIを上手く使うと効率的に業務を回せようです。ではまた。
