> For the complete documentation index, see [llms.txt](https://docs.nexthink.com/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 を呼び出し、アクションをトリガーしたり外部データを取得したりできます。たとえば、Spark と Workspace では、これらを使用して ITSM ツールでインシデントを作成できます。

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

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

Nexthink は、Microsoft Entra ID、Microsoft Intune、Atlassian Jira、Okta、ServiceNow などのツール向けに事前構築された統合を備えた、すぐに使用できる API 呼び出しをシステムコンテンツとして提供しています。

<figure><img src="https://268444917-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxJSUDk9NTtCHYPG5EWs3%2Fuploads%2FdoIjgT3tE4VtxO3Qqcf7%2F2026.9_API_setup_3_Mb5Tp8Lx3e.png?alt=media&#x26;token=1e910b8b-9c56-4f2d-b4fd-7f059425c94d" alt=""><figcaption></figcaption></figure>

次のことができます：

* システム API 呼び出しをそのまま使用するか、ニーズに合わせて変更します。設定後、**Triggering** でそれを使用できる機能を選択します。元の内容を変更せずに保持するには、システム API 呼び出しを複製し、コピーをカスタマイズします。
* 新しい API 呼び出しを一から作成します。詳細については、[新しい API 呼び出しの作成](#creating-a-new-api-call) を参照してください。

## 開始する前に

API 呼び出しの接続先となるサードパーティツールの資格情報を作成します。詳細については、[サードパーティの資格情報](https://docs.nexthink.com/platform/ja/configuring_nexthink/bringing-data-into-your-nexthink-instance/integrating-nexthink-with-third-party-tools/outbound-connectors/connector-credentials.md)を参照してください。

## 新しい API 呼び出しを作成する

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

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

API 呼び出しの識別方法、使用するコネクタと資格情報、およびトリガーできる機能を定義します。

* **名前**: API 呼び出しにとって意味のある名前を入力します。この名前は **管理** ページに表示されます。
* **NQL ID**: NQL クエリで API 呼び出しを参照するときに使用する一意の識別子が自動的に作成されます。提案された NQL ID は最初に変更できますが、API コールを保存すると以後は NQL ID を変更できなくなります。
* **説明**: API 呼び出しの機能、データの読み取りまたは変更の有無、およびその影響について説明します。エージェントは、実行する API 呼び出しを判断するためにこれを必要とします。
* **コネクタ（任意）**: API 呼び出しが属するサードパーティプラットフォームのコネクタを選択します。例: **Entra ID**。コネクタは、プラットフォームの API 呼び出しをグループ化します。
* **資格情報**: **サードパーティの資格情報**ページから事前設定済みの資格情報を選択します。詳細については、[サードパーティの資格情報](https://docs.nexthink.com/platform/ja/configuring_nexthink/bringing-data-into-your-nexthink-instance/integrating-nexthink-with-third-party-tools/outbound-connectors/connector-credentials.md)ドキュメンテーションを参照してください。
* **URL**: 資格情報を選択すると、システムがこのフィールドに自動的に入力します。
* **トリガー**: API 呼び出しを使用できる機能を選択します。

<figure><img src="https://3549141153-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeLm8O7QKZDn6z806e7Sv%2Fuploads%2Fgit-blob-3e6091e87a187f39d0c83518a2efeccf2124a763%2F2026.9_API_setup_21_Qp4Vn7Ks2c.png?alt=media" alt=""><figcaption></figcaption></figure>

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

Nexthink がサードパーティツールに送信するリクエストを定義します。

#### パラメータ

呼び出し元の機能が実行時に API 呼び出しへ渡す値を定義します。 **Add parameter** をクリックし、次のフィールドに入力します。

* **名前**: パラメーターの説明的な名前を入力します。
* **ID**: `{{id}}` の形式を使用して、**リソース**、**ペイロード**、および**カスタムヘッダー**の各セクションでパラメーターを参照するために使用される一意の識別子です。自動的に作成されます。
* **説明**: パラメーターの目的を簡潔に説明します。
* **Restriction**: エージェントがこのパラメーターに渡す値を制限するかどうかを選択します。 **None** を選択すると、制限は適用されません。 **User** を選択すると、値はユーザーのプロパティである必要があります。 **Restrictions** は現在、**Spark** にのみ適用されます。
* **制限プロパティ**: エージェントが渡すことのできるユーザープロパティを選択します: **AD Username**、**Email address**、**SID**、または **UPN**。

<figure><img src="https://3549141153-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeLm8O7QKZDn6z806e7Sv%2Fuploads%2Fgit-blob-82193348c83c8eb87c4be5530ca07b2239545579%2F2026.9_API_setup_22_Wz8Hb1Fm6t.png?alt=media" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
制限は現在、**Spark** にのみ適用されます。これにより、**Spark** がサードパーティツールへの API 呼び出しを行う際に、接続されているユーザーのみを対象にできるようになります。
{% endhint %}

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

たとえば、API 呼び出しでサポートチケットを作成する場合は、**Description** パラメーターを定義します。 Spark は実行時に値を提供し、リクエストはその値をチケットのペイロードに含めます。詳細については、[Spark を使用したチケットエスカレーションの設定](https://docs.nexthink.com/platform/ja/user-guide/spark/setting-up-and-managing-spark/ticket-escalation-with-spark.md)を参照してください。

#### HTTP コール

Nexthink がサードパーティ API に送信する HTTP リクエストを定義します。

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

<figure><img src="https://3549141153-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeLm8O7QKZDn6z806e7Sv%2Fuploads%2Fgit-blob-0f9ca46597958ef5c29a23612573a47a8167b30b%2F2026.9_API_setup_23_Ag3Rd9Lx5y.png?alt=media" alt=""><figcaption></figcaption></figure>

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

認証トークンなど、サードパーティ API で必要となる追加の HTTP ヘッダーを定義します。ヘッダーを追加するには、**Add custom header** をクリックします。

<figure><img src="https://3549141153-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeLm8O7QKZDn6z806e7Sv%2Fuploads%2Fgit-blob-ed6ada6b707b48a315c421687e0172df709f3d9d%2F2026.9_API_setup_24_Ju6Tc2Ps8n.png?alt=media" alt=""><figcaption></figcaption></figure>

### 出力タブの設定

API レスポンスから抽出する値を定義するには、**Add output** をクリックします。

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

<figure><img src="https://268444917-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FxJSUDk9NTtCHYPG5EWs3%2Fuploads%2FiMFi5bX9flYz3yCBLMwW%2F2026.9_API_setup_8_Ew6Qj5Lf4o.png?alt=media&#x26;token=b523ad88-675c-4e74-847c-3d7f9ecc8921" alt=""><figcaption></figcaption></figure>

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

たとえば、API コールでサポートチケットを作成する場合は、レスポンスからチケット ID を返す出力を定義します。 API レスポンスが `{"result": {"number": "INC001"}}` の場合、`INC001` を返すには **Value (JSONata)** に `result.number` を入力します。

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

パラメーターとペイロードを設定した後、ページ右側の **Test results** パネルを使用して実際のデータで API 呼び出しを実行し、レスポンスを確認してエラーを特定します。テストパネルは、設定の検証と試行錯誤の削減に役立ちます。

1. 各パラメーターの値を入力します。
2. **Run test** をクリックして API を呼び出し、認証情報を検証し、エンドポイントへの接続性を確認します。
3. レスポンスのステータスコード、レスポンス時間、および API のレスポンスを確認します。
4. **Output** タブの **Preview** 列で、抽出された出力フィールドを確認します。
5. API 呼び出しを保存します。 **API Calls** ページのテーブルに表示されます。

{% hint style="warning" %}
テストでは実際の API 呼び出しが実行されます。設定によっては、サードパーティツールのデータを更新または削除する可能性があります。
{% endhint %}

## API コールの管理

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

* **Name**: API 呼び出しの名前。名前を選択して API コールを編集します。
* **作成元**: API コールの作成元を示します。
  * **System**: Nexthink がシステムコンテンツとして標準で提供する API 呼び出し。
  * **Custom**: Nexthink Web インターフェイスの **API Calls** ページで作成した API 呼び出し。
* **Description**: API 呼び出しの簡単な説明。
* **資格情報**: HTTP リクエストの認証に使用される資格情報。

<figure><img src="https://3549141153-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeLm8O7QKZDn6z806e7Sv%2Fuploads%2Fgit-blob-0a7823e215d3643212793e88f803efa28cb0faa9%2F2026.9_2026.9_API_setup_15_Ub7Kr2Xn9e.png?alt=media" alt=""><figcaption></figcaption></figure>

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

該当する API 呼び出しの縦に並んだドットをクリックすると、次のオプションを含むアクションメニューが開きます:

* **Edit**: API 呼び出しの設定を変更します。
* **Manage tags**: API 呼び出しのタグを作成、割り当て、編集します。詳細については、[リモートアクションのタグ付け](https://docs.nexthink.com/platform/ja/user-guide/remote-actions/setting-up-and-managing-remote-actions/managing-remote-actions.md#managingremoteactions-creatingandassigningtags)を参照してください。
* **Share**: 他のロールに **Execute** 権限を付与します。たとえば、管理者のみが API 呼び出しを実行できるようにします。 API 呼び出しを共有するロールを選択します。詳細については、[Permissions](#permissions)を参照してください。
* **Duplicate**: API 呼び出しのコピーを作成し、開始点として使用します。システム API 呼び出しを複製することで、元の呼び出しを変更せずにカスタマイズできます。
* **Delete**: システムから API 呼び出しを削除します。
* **Copy call Id**: API 呼び出しの一意の識別子をコピーします。

## パーミッション

API 呼び出しに使用できる権限は **Execute** のみです。 Workspace で API 呼び出しを使用するには、ユーザーは少なくともいずれかのロールでその API 呼び出しに対する **Execute** 権限を持っている必要があります。

次のいずれかの方法で **Execute** 権限を付与します。

* API 呼び出しをロールと共有します。詳細については、[Action menu](#action-menu)を参照してください。
* ロール権限の **Integrations** セクションで、そのロールが実行できる API 呼び出しを選択するか、すべての API 呼び出しを実行する権限を付与します。詳細については、[Roles](https://docs.nexthink.com/platform/ja/user-guide/administration/account-management/roles.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.
