Kandji API トークンの構成
API リクエストを行うには、API を操作するときに必ず使用する API キーを作成します。
API トークンの作成手順については、 Kandji API の記事を参照してください。
新しい API トークンは、後で使用するために安全な場所に保管します。
他のサードパーティのAPIツールを使用することもできますが、迅速なセットアップのために現在のAPI コマンドをすべてインポートできる Postman コレクションが用意されています。
Postmanのインストール
デバイスにPostmanがすでにインストールされている場合は、この手順をスキップしてください。
PostmanのWebサイトにアクセスして、Postmanアプリをダウンロードします。
Postman.app をアプリケーションフォルダにコピーします。
アプリケーションを起動します。
Postman を構成する
Postmanを初めて起動する場合は、無料アカウントを作成するか、サインインするか、スキップしてアプリへのサインインを避けることができます。
Postman の [設定] を確認して、テーマなどの設定を調整します。
Kandji API コレクションを Postman にインポートする
次の手順に従って、使用可能なすべての Kandji API 要求を Postman に簡単にインポートします。
新しい Kandji API コマンドが追加された場合、これらの新しいコマンドをコレクションで使用できるようにするには、 Kandji API を再度インポートする必要があります。
api-docs.kandji.io にアクセスし、ページの右上にある[Postmanで実行]ボタンをクリックします。
Mac用のPostmanを選択します。
「この Web サイトに "Postman.app" を開くことを許可しますか?」 プロンプトで [許可] を選択します。注:このプロンプトは、使用しているインターネットブラウザによって異なる場合があります。
コレクションを追加するワークスペースを選択します。
[インポート] を選択します。
環境変数の作成
環境変数を作成すると、API トークンなどの値をより安全に格納し、Postman の異なるコレクション間で同じ変数を使用できます。これについての詳細は 、Postman's Collections の記事でご確認いただけます。
[ファイル] をクリックします。
[新規] をクリックします。
環境 を選択します。
次の変数を環境に追加し、タイプをシークレットに設定します
api_token、device_id、ade_token_id
この時点で、 api_tokenの値を定義し、その情報が使用可能な場合にのみ、他の値を定義します。
「保存」をクリックします。
環境の設定
ガイドに従って新しい Postman 環境を選択します。
Kandji API 変数の定義
コレクションパネルで、[ Kandji API] をクリックします。
中央のパネルで、[変数]タブをクリックします。
API URL 変数の値を定義します。API URL を見つけるには
[設定]に移動します。
[アクセス] タブをクリックします。
[API トークン] セクションに移動します。
API コマンドの実行
これで、API コマンドを実行する準備が整いました。特定の API コマンドの詳細については、 API ドキュメントをご覧ください。