APIキーの作成

概要¶

APIを使用するための「APIキー」の発行について説明します。

APIキーとは何か¶

外部プログラムからAPIを使用するには、APIを誰がどの権限でアクセスしているのかをプリザンターに認識させるため、「APIキー」を指定する必要があります。外部からプリザンターのAPIを呼び出す場合、「APIキー」の指定は必須となりますが、ログインしているブラウザのセッションからアクセスする場合には「APIキー」を指定せずに使用することも可能です。この場合は、ログインしているユーザの権限でAPIは実行されます。スクリプト、サーバスクリプトでパラメータにログインユーザ以外の「APIキー」を指定する場合は、指定したユーザの権限でAPIは実行されます。APIで取得するPleasanterの時刻は、「APIキー」を作成したユーザが設定しているタイムゾーンに変更されます。

注意事項¶

1. 「APIキー」が漏洩すると外部プログラムからアクセスが可能となります。「APIキー」は他者に知られないよう厳重に管理してください。

操作手順¶

APIキーを発行するユーザでプリザンターにログインし、下記の手順でAPIキーを発行してください。

APIキー発行後の画面操作¶

APIを許可するIPアドレス範囲¶

1.5.9.0

APIキーごとに、APIキーを使える接続元のIPアドレスを制限できます。社内ネットワークなど、決まった接続元からだけAPIキーを使えるようにできます。

設定方法¶

何も入力しない場合は、IPアドレスによる制限はかかりません。

指定できるのはIPv4のアドレスだけです。書式が正しくない行があると、「IPアドレス範囲の書式が正しくありません。(192.168.1.300)」のように、括弧の中に該当する値が示され、保存できません。

APIキーを再作成・削除しても、設定したIPアドレス範囲は残ります。

適用範囲¶

この設定は、APIキーを指定したリクエストに適用されます。$p.apiGet などの関数でも、引数 data に ApiKey を指定したときは適用されます。ApiKey を指定しない場合は、ログインしているユーザの権限で実行され、この設定は適用されません。

APIキーを使ったMCPサーバへのアクセスにも、同じ制限が適用されます。

許可されていないIPアドレスからAPIキーでアクセスすると、エラー（HTTPステータス 403）になり、「このIPアドレスからのAPIキーの利用は許可されていません。」というメッセージが返ります。パラメータや契約によるIPアドレス制限で拒否された場合とは、メッセージで区別できます。

パラメータ（Security.jsonの「AllowIpAddresses」）や契約（Pleasanter.netのIPアドレス制限オプション）によるIPアドレス制限を設定している場合は、それらの制限もこれまでどおり適用されます。

対応バージョン¶

関連情報¶

• 開発者ガイド：API