APIキーの作成および認証方法について

山崎 翔平

2021-10-16T07:29:52.247Z

APIキーの作成について

各APIサービスを利用するためには、まずAPIキーを作成する必要があります。
管理画面にアクセスできるアカウントでログインし、APIキーを作成しましょう。なお、APIキーの権限は、作成するアカウントの権限と同等になります。

管理画面の右上の名前が書かれた箇所をクリックすると表示されるポップアップ内のプロフィールリンクをクリックし、プロフィール詳細画面へと遷移してください(「システム管理 > ユーザー一覧 > ユーザー詳細」でも同等の画面が表示されます)

上部のタブのうち、「APIキー」というタブがあるのでクリックしてください。APIキーを未作成の場合は、「データがありません」と表示されます。右上にある、「作成する」リンクをクリックしてください。

APIキー作成1.png

「作成する」リンクをクリックすると、APIキーの名前を入力する欄が表示されます。APIキーの名前は何でも良いですが、APIキーの利用用途が分かるような名前が良いでしょう。名前を入力したら「保存する」ボタンをクリックしてください。

APIキー作成2.png

「保存する」ボタンをクリックすると、APIキーが生成され、下のような画面になります。APIキー自体はマスクされていますが、右の目のアイコンをクリックすると全てのAPIキーが表示されます。このAPIキーを利用すると、ログインしているアカウントと同等の権限のことができるようになります。大切に保管してください。また、万が一APIキーが流出した場合は、APIキーを削除することで IBISEには削除したAPIキーではアクセス出来なくなります。

APIキー作成3.png

各APIサービスを利用する際の認証方法について

各APIサービスを利用する際のユーザー認証にて、HTTPリクエストの Authorization ヘッダーにて、APIキーを指定します。

Authorization: Bearer {API Key}

IBISE APIサービスでは、Authorization ヘッダーの Bearer 以降の埋め込まれている APIキー を基に認証を行います。Bearer と APIキーの間には、半角スペースが入っていることに注意してください。

お問い合わせ