Skip to main content

APIキーの管理

APIキーは、ユーザーがケンオールAPIにアクセスするための資格情報です。

ケンオールAPIにアクセスするには、APIキーが必要です。

APIキーは2種類存在します。

  • 公開キー: 住所入力フォームなど、公開されたページなどで使うことを前提としたAPIキー。設定したドメインからのみアクセス可能。
  • シークレットキー: システム内部など、非公開の環境で使うことを前提としたAPIキー。

ダウンロードAPIなどの一部のAPIはシークレットキーの利用を前提としています。

APIリファレンスに特に記載がない場合は公開キーでそのAPIを利用できます。

warning

シークレットキーは必要最低限の関係者のみがアクセスできるように厳重に管理し、決して第三者に共有しないようにしてください。

APIキーを取得する#

ダッシュボードのホームより、APIキーを取得することができます。

ログイン直後は、公開キーのみが生成されています。

公開キーをクリックすると、クリップボードにコピーすることができます。

公開キーを再生成する#

公開キークリックして再生成をクリックすると、公開キー再生成の確認ダイアログが表示されます。

再生成するボタンをクリックすると、公開キーが再生成されます。

caution

APIキーを再生成した場合、既存のAPIキーは即座に無効化されます。この操作は取り消せません。

シークレットキーを生成する#

シークレットキークリックして生成をクリックすると、シークレットキー生成の確認ダイアログが表示されます。

再生成するボタンをクリックすると、シークレットキーが生成されます。

一度生成した後は、公開キーと同様、いつでも再生成することができます。詳細は公開キーを再生成するを参照してください。