PythonでBacklog APIを利用するまで

仕事でBacklogを使用しており、今後Backlog APIを使うので導入方法をまとめておきます。

Backlog APIとは?

課題,Wiki,ファイルの追加や取得を始め、プロジェクトやユーザーの管理などブラウザ上のBacklogでできる操作の大部分をAPIから行うことができます。詳しくはAPI リストを参照してください。 また、Cross Origin Resource Sharing (CORS) によるブラウザ上でのAjaxを使用したクロスドメイン通信が可能です。

https://developer.nulab-inc.com/ja/docs/backlog/

認証方法について

今回、バックエンド処理でBacklogから情報を取得することを想定して、API Key方式で利用します。

https://developer.nulab-inc.com/ja/docs/backlog/auth/

API Keyを取得する

Backlogにログインし、アカウント設定画面を開きます。

メニューのAPIをクリックします。
f:id:maroemon58:20180609145757p:plain

メモを適当に入力します。アプリ名や用途など記載しておくといいでしょう。
f:id:maroemon58:20180609145825p:plain

登録ボタンをクリックしたら一覧にAPIキーが追加されますので、コピーしておきましょう。
f:id:maroemon58:20180609145844p:plain

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を上手く使うと効率的に業務を回せようです。ではまた。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

ABOUTこの記事をかいた人

Yusuke Ito

20代後半プログラミング未経験から転職し、現在はWEBエンジニアとして働いています。 バックエンドが本職ですが、1人でサービスを立ち上げるためフロントエンドも勉強中です。 最近はDAppsやNEMの開発に夢中です。