APIキーの管理

APIキーとは

APIキーはあなたのアカウントを証明するための鍵となる情報です。APIキーを使うことで、NipoPlusを経由すること無く直接日報やテンプレートなどのデータをダウンロードすることができます。 どちらかといえばWeb技術者向けの機能であり、単純にNipoPlusをアプリから利用する場合は一切触れる必要のない機能です。 例えばAPIキーとCURLを使って日報のデータをダウンロードし、そのデータを今度は社内の基幹システムに送信するといったことが出来るようになります。

日報データをCSVに出力してそれを機関システムにインポートすることもできるけど、CSV出力も自動化したいと思うのがプログラマの性です

APIキーの取得

APIキーを取得するには、APIキーを取得するアカウントで次の手順に従って操作します。

1. メニューから「アカウント」をクリックします
2. APIのセクションまでスクロールします
3. ログインパスワードを入力します

上記の手順で正しいパスワードが入力されるとAPIキーが画面に表示されます。APIキーの隣に「コピー」ボタンが表示されますので、そのボタンを使ってAPIキーをコピーし、安全な場所に貼り付けて保管してください。

APIキーはパスワードくらい重要な情報だから大切に管理してね

APIキーの無効化

APIキーが万が一外部に流出した場合や、スタッフが退職してAPIキーを無効にする必要がある場合はAPIキーを破壊してください。 APIキーを破壊するには自身でAPIキーを破壊する方法と、管理者がスタッフのアカウントを無効化することでキーを破壊する方法があります。

自分のアカウントから自分のAPIキーを無効化する

1. APIキーの取得画面のすぐ下に「APIキーの破壊」というボタンがありますのでこちらをクリックします。
2. 確認メッセージが表示されるのでOKをクリックします
3. APIキーの無効化と同時にログアウトが行われます

以上の手順でAPIキーを無効化できます。新たにAPIキーが必要な場合は再びAPIキーを取得してください。

APIキーの無効化にはパスワード入力は不要です

スタッフアカウントを無効化してAPIキーを無効にする

こちらは管理者が社内スタッフのAPIキーを無効化する手順です。組織設定からスタッフアカウントを無効化することで、そのスタッフのAPIキーも含めて無効化されます。

1. 管理者アカウントで操作します
2. 組織設定をクリック
3. スタッフ管理のセクションで無効化するスタッフを見つける
4. 「有効」ボタンをクリックする（即座にボタンが「無効」に変わります）

再度スタッフを有効にすることもできますが、無効化した時点で過去のAPIキーは破壊されているためアカウントが有効に戻ってもAPIキーは再取得する必要があります。 より詳しいガイドはスタッフアカウントの管理を御覧ください。

その他のAPIキーの失効条件

NipoPlusのAPIキーは基本的に長命ですが、以下のケースでは強制的に失効します。

• ユーザアカウントが削除されたとき
• ユーザアカウントで大きな変更が検知された時（パスワードやメールアドレスの変更など）