> For the complete documentation index, see [llms.txt](https://docs.nexthink.com/platform/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nexthink.com/platform/ja/configuring_nexthink/bringing-data-into-your-nexthink-instance/integrating-nexthink-with-third-party-tools/api-calls.md).

# API 呼び出し

**API 呼び出し**を使用すると、必要に応じてサードパーティの API を呼び出し、アクションをトリガーしたり外部データを取得したりできます。 API 呼び出しは、ITSM ツールでのインシデント作成など、主にチケットエスカレーションのシナリオ向けに Spark 統合をサポートします。

## API 呼び出しへのアクセス

**API 呼び出し**ページにアクセスするには、メインメニューで **管理** > **API 呼び出し** に移動します。 **API 呼び出しの管理**ページが開き、この Nexthink インスタンスで設定されているすべての API 呼び出しが一覧表示されます。

## 新しい API 呼び出しの作成

ページの右上隅にある **新しい API 呼び出し** ボタンをクリックします。ページが開き、**一般**プロパティ、**リクエスト**、**出力**を設定できます。

### ［一般］タブの設定

* **名前**: API 呼び出しにとって意味のある名前を入力します。この名前は **管理** ページに表示されます。
* **NQL ID**: NQL クエリで API 呼び出しを参照するときに使用する一意の識別子が自動的に作成されます。提案された NQL ID は最初に変更できますが、API コールを保存すると以後は NQL ID を変更できなくなります。
* **説明**: API コールの目的と動作に関する簡潔な説明です。
* **資格情報**: **サードパーティの資格情報**ページから事前設定済みの資格情報を選択します。詳細については、[サードパーティ認証情報](/platform/ja/configuring_nexthink/bringing-data-into-your-nexthink-instance/integrating-nexthink-with-third-party-tools/outbound-connectors/connector-credentials.md)ドキュメンテーションを参照してください。
  * **URL**: 資格情報を選択すると、システムがこのフィールドに自動的に入力します。

### リクエストタブの設定

#### パラメータ

**パラメーターを追加**をクリックして、API コールに必要なパラメーター値を定義します。

* **名前**: パラメーターの説明的な名前を入力します。
* **ID**: `{{id}}` の形式を使用して、**リソース**、**ペイロード**、および**カスタムヘッダー**の各セクションでパラメーターを参照するために使用される一意の識別子です。自動的に作成されます。
* **説明**: パラメーターの目的を簡潔に説明します。

パラメーターは任意です。これらを使用すると、Spark などの呼び出し元の機能から実行時の値を受け取り、それらの値を HTTP リクエストのリソース、ペイロード、またはヘッダーに挿入できます。

たとえば、API コールでサポートチケットを作成する場合は、**説明**パラメーターを定義します。

{% hint style="info" icon="sparkles" %}
Spark は実行時に値を提供し、リクエストにはその値がチケットのペイロードに含まれます。詳細については、[Spark によるチケットエスカレーションの設定](/platform/ja/user-guide/spark/setting-up-and-managing-spark/ticket-escalation-with-spark.md)を参照してください。
{% endhint %}

#### HTTP コール

* **リクエストメソッド**: 使用する HTTP メソッド（例: GET、POST、PUT、PATCH）を選択します。
* **リソース**: サードパーティ REST API のエンドポイントパスまたはアクションを定義します。これにより実行される操作が決まります。
* **ペイロード（任意）**: POST、PUT、または PATCH メソッドで送信するデータを指定します。

#### カスタムヘッダー

**カスタムヘッダーを追加**をクリックして、認証トークンなど、サードパーティ API で必要となる追加の HTTP ヘッダーを含めます。

### 出力タブの設定

* **名前**: 出力フィールドの説明的なラベルを入力します。
* **説明**: API レスポンスから抽出されたデータについて簡潔に説明します。
* **値（JSONata）**: API レスポンスから返されるフィールド名を入力します。必要に応じて、値の変換に [JSONata](https://docs.jsonata.org/overview) を使用します。空白または [JSONata](https://docs.jsonata.org/overview) の予約文字（`.`, `+`, `-`, `*`, `/`, `{` など）を含むフィールド名は、バッククォート（\\\`）で囲む必要があります。
* **プレビュー:** API から受信したレスポンスに適用された JSONata 式の結果を表示します。この操作を行うには、まず [テストパネル](#test-your-api-call)を使用してテストを実行する必要があります。

出力は任意です。これらを使用すると、レスポンス本文やヘッダーなど、HTTP レスポンスから値を抽出し、その値を Spark などの呼び出し元の機能に公開できます。

たとえば、API コールでサポートチケットを作成する場合は、レスポンスからチケット ID を返す出力を定義します。

### API コールをテストする

パラメーターとペイロードを設定した後、**テスト結果**パネルを使用して実際のデータで API コールを実行し、レスポンスを確認してエラーを特定します。**プレビュー**列で抽出された出力フィールドを確認します。テストパネルは、設定の検証と試行錯誤の削減に役立ちます。

## API コールの管理

テーブルのタイトルで API コールの合計数を確認します。 API コールの名前を検索して、結果を絞り込みます。テーブルは次の項目で構成されています。

* **名前**: API コールの名前。名前を選択して API コールを編集します。
* **作成元**: API コールの作成元を示します。
  * **カスタム**: Nexthink Web インターフェイスの **API コール**ページで作成された API コール。
* **説明**: API コールの簡潔な説明。
* **資格情報**: HTTP リクエストの認証に使用される資格情報。

### アクションメニュー

該当する API コールにカーソルを合わせると、次のオプションを含むアクションメニューが表示されます。

* **編集**: API コールを変更します。
* **削除**: システムから API コールを削除します。

***

関連ページ

* [Spark によるチケットエスカレーションの設定](/platform/ja/user-guide/spark/setting-up-and-managing-spark/ticket-escalation-with-spark.md)
* [サードパーティ認証情報](/platform/ja/configuring_nexthink/bringing-data-into-your-nexthink-instance/integrating-nexthink-with-third-party-tools/outbound-connectors/connector-credentials.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.nexthink.com/platform/ja/configuring_nexthink/bringing-data-into-your-nexthink-instance/integrating-nexthink-with-third-party-tools/api-calls.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.