---
title: "API Explorerタブ"
slug: "the-api-explorer-tab"
abstract: "Sitecore Search API Explorer JSON Searchや推奨APIへの要望をテストします。"
---
# API Explorerタブ

Sitecore Searchの**Developer Resources**ページの**API Explorer**タブは、開発者が自分のデータに対してリクエストを作成・実行する場所です。これは[検索およびrecommendation API](https://doc.sitecore.com/search/ja/developers/search-developer-guide/integrating-using-rest-apis/using-the-search-and-recommendation-api-to-create-search-experiences.html "Using the Search and Recommendation API to create search experiences")を活用したライブかつインタラクティブな方法です。このトピックでは、このツールを活用できる多くの方法について説明します。

**API Explorer**タブは、**Builder**ペイン、**Request**ペイン、**Response**ペインの3つのペインに分かれています。

![api\_explorer.png](https://doc.sitecore.com/api/markdown-image/search/ja/developers/search-developer-guide/images/api_explorer.png)

## 建設

**ビルド**ペインでAPIリクエストの[値を入力または選択](https://doc.sitecore.com/search/ja/developers/search-developer-guide/the-sitecore-search-interface/the-api-explorer-tab/test-a-search-request-using-the-api-explorer.html "Test a search request using the API Explorer")できます。

Sitecore Search実装は、各ページに要件を満たすウィジェットがあるページ向けに設定されています。ページに設定されたURLまたはURLパターンがその内容を決定します。ページを選択すると、その設定済みのURLやURLパターンが **ビルド** ペインのURL入力フィールドに設定されます。

> !注**API Explorer**はウィジェットがページに含まれていないためAPIリクエストpreview search作成できません。 **Build**はページに対してのみAPIリクエストを構築できます。

リクエストを見るには **「ビルド**」をクリックしてください。リクエストは**Request**ペインに表示されます。

## Request

このペインでは、リクエストがJSON形式で表示されます。このペインでJSONを直接編集できます。

以下のコードはリクエストの例です。

{
 "context": {
 "page": {
 "uri": "/search"
 },
 "user": {
 "user\_id": "12145"
 }
 },
 "widget": {
 "rfkid": "rfkid\_7"
 },
 "content": {
 "product": {}
 }
}

> !注エラーは、リクエストにクエリに関連する値が欠けている場合に設定または更新すべき値を示します。

Click ![open\_in\_full.png](https://doc.sitecore.com/api/markdown-image/search/ja/developers/search-developer-guide/images/open_in_full.png) はパネルの右上にあり、サイズを大きくします。

リクエストをエクスポートするには、「 **クリップボードにコピー」** をクリックし、以下のオプションから選択してください:

-   *Sitecoreホストを使ってcURLとしてコピーしてください*
-   *サブドメインを使ってcURLとしてコピーしてください*
-   *コードで使用するデータオブジェクトとしてコピーしてください。*

リクエストをテストするには **、「実行**」をクリックしてください。応答は **「応答** 」ペインに表示されます。

> !重要検索体験を妨げないため、APIは決して失敗しないように設計されています。常に利用可能な情報に基づいて次に良い結果を返します。

## 反応

リクエストへのJSON応答はこのペインに表示されます。JSONを折りたたんで展開することで構造を確認し、レスポンスを検証できます。回答をエクスポートするには、「 **クリップボードにコピー」** をクリックし、その後「 **データオブジェクトとしてコピー**」をクリックします。