APIキーの取得

APIを使うとアプリを使わず直接報告書のデータを取得することができます。 主に外部のシステムと連携するのに使用します。 APIキーで報告書を読むことができるのでAPIキーは厳重に管理し、外部に漏洩しないように注意してください。

APIキーを有効にする

APIの有効無効設定は管理者権限が必要です。

  1. メニューから組織設定をクリック
  2. APIを有効にするスタッフを見つける
  3. APIの項目をクリックして緑色のボタンにする
スタッフごとにAPIキーの利用を許可・禁止にできます。初期状態では全スタッフが「禁止」ですスタッフごとにAPIキーの利用を許可・禁止にできます。初期状態では全スタッフが「禁止」です スタッフごとにAPIキーの利用を許可・禁止にできます。初期状態では全スタッフが「禁止」です

初期状態では全員無効(赤色ボタン)です。安全のためにも利用するスタッフは最小限にとどめてください

APIキーの取得

APIキーは上記手順で有効されたスタッフの画面から取得ができます。

  1. メニューから「アカウント」をクリックします
  2. APIのセクションまでスクロールします
  3. ログインパスワードを入力します
  4. APIキーの取得ボタンをクリックします
APIキーを取得するには再認証のためログインパスワードの入力が必要ですAPIキーを取得するには再認証のためログインパスワードの入力が必要です APIキーを取得するには再認証のためログインパスワードの入力が必要です

上記の手順で正しいパスワードが入力されるとAPIキーが表示されます。コピーして保存します。

APIキーを無効にする

以下の場合はAPIキーを速やかに無効化してください。

  • APIキーが外部に流出した可能性がある
  • APIを使う必要が無くなった
  • APIを使用しているスタッフが退職した

APIキーを無効にする方法はいくつかあります。一番シンプルなのはAPIを有効にするときの逆の手順で、管理者がスタッフのAPIを赤色ボタン(無効)にすることです。

上記手順以外にAPIキーを無効にする方法もありますが、他の手順は無効化時にログアウトされます。

  • スタッフアカウントのAPI発行画面の下部にある「APIの破壊」をクリック
  • スタッフアカウントの状態が「無効」にされるとき
  • ユーザアカウントが削除されたとき
  • ユーザアカウントで大きな変更が検知された時(パスワードやメールアドレスの変更など)
tag有料プラン限定 tagスタッフアカウント管理
nipoplusアプリ起動ボタン

匿名アカウントで手軽に体験🛫

匿名アカウントは仮で発行されるIDです。面倒なアカウント作成をスキップして手軽にNipoPlusを体験できます。

匿名アカウントとは? NipoPlusを起動
ios App Store Android Google Play Store