こんにちは。笹川です。
Backlog助っ人では、スペース間のプロジェクト移行のご依頼を多くいただいています。
組織変更や合同プロジェクトの解散による自社スペースへの持ち帰りなど、Backlog間でもプロジェクトを移行するケースはよくあることのようです。
助っ人での移行作業にあたり、移行元スペースと移行先スペースのAPIキーをお客様に必ず発行いただく必要があります。
最近移行作業でお客様とやり取りする中で、普段ITに関わることのない方にはAPIキーと聞いてもどうもピンと来ないということに気づきました。
なので、今回はAPIキーの発行方法や、必要な理由、管理についての記事にしてみようと思いました。
サービスの利用について迷われている方の参考になればありがたいです。
Backlog API ・・・課題を追加する・担当者を更新するなど、Backlogの操作を画面を通さずに行うための窓口
APIキー ・・・・窓口を利用する資格があるかを確認するための本人確認書類
APIとは？
API（Application Programming Interface）とは、プログラム同士を繋いでやり取りを行うための機能です。
私たちも普段、LINEやYouTube、Googleマップなどのどこかにあるデータを、様々なアプリを使い、送受信や通知、連携したりして利用しています。
このようなデータの受け渡しを異なるプログラム間で行うことができるのは、APIがあるからなのです。
BacklogにもAPIが用意されていて、例えば他のアプリケーションから課題を登録したり、通知を送信したり、課題のステータスを一括取得して一覧できるダッシュボードを作成したり…といったカスタマイズが可能です。
Backlog助っ人でも、このAPIを使用してプロジェクトの中身を取得することで、プロジェクト移行やツール作成を行っています。
APIキー🔑
そんな便利なAPIですが、誰でも簡単にデータの取得ができるなら極秘プロジェクトの中身が筒抜けになってしまうのではないかと心配になってしまいますが、大丈夫です！
Backlog APIは、APIキーという秘密の文字列を知っている人だけが使用できるようになっているのです。
つまり、APIキーというのは、勝手に使われては困るAPIへのアクセス制限をするパスワードのようなものですね。
プロジェクト移行での使用目的
Backlog助っ人サービスのプロジェクト移行では、Backlog公式の「プロジェクト移行ツール」を使用したプロジェクト移行を行っています。このツールでは、移行元から対象のプロジェクトデータを一括取得し、取得したデータを移行先へ一括登録を行いますが、この取得や登録に使うのもAPIなのです。
そのため、データ取得のために移行元スペースのAPIキーが、そしてデータ登録のために移行先スペースのAPIキーが必要となります。
※APIキーの管理について【重要！】
BacklogのAPIキーは複数発行可能ですが、同じアカウントから発行されたAPIキーでできることは、どのAPIキーを使用しても同じです。それなら1つだけで発行して使いまわせば良いのでは？と思われるかもしれませんが、APIキーは目的ごとに発行します。
そうすることで、その目的が必要なくなった時に、キーを削除して無効化することができるからです。
助っ人サービスのプロジェクト移行においても、作業前にキーを発行し、作業完了後に速やかに削除することで、機密情報を安心して保護していただくことが可能です。
Backlog APIキーの発行方法
おわりに
いかがでしたでしょうか。APIキーについて理解し、安全に使用していただければと思います。
Backlog助っ人では、プロジェクトの移行だけのみならず、APIを使用してこのようなダッシュボード作成のカスタマイズも行っています。オリジナルダッシュボード作成にご興味がありましたらお気軽にお問い合わせください！
ピンバック: BacklogをAWSと組み合わせて定期タスクを自動登録するBacklog助っ人サービス