> For the complete documentation index, see [llms.txt](https://docs.keeper.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keeper.io/enterprise-guide/jp/api-troubleshooting/api-explorer-swagger.md).

# APIエクスプローラ - Swagger

## 概要

本ページでは、Swaggerを用いてFamily Plans APIおよびStudent Plans APIを理解し、独自のサンプルをテストする方法を取り扱います。

## SwaggerによるAPIエクスプローラ

1. <https://editor.swagger.io/>にアクセスします。
2. 利用するプロビジョン・エンドポイントのYAMLファイルをダウンロードします。\
   [ファミリープラン](/enterprise-guide/jp/personal-vaults-for-enterprise-and-business-users/provision-family-plans-via-api.md)\
   [学生プラン](/enterprise-guide/jp/personal-vaults-for-enterprise-and-business-users/provision-student-plans-via-api.md)
3. Swagger Editorで **\[File]** > **\[Import]** をクリックし、手順2でダウンロードしたYAMLファイルを選択します。
4. YAMLファイルをインポートすると、左側の画面にAPI構成、右側にAPIエクスプローラが表示されます。

<figure><img src="/files/qj1qrATg9sZv9Aq995nW" alt=""><figcaption><p>この例では、ファミリープランのYAMLファイルを使用します。</p></figcaption></figure>

5. 右側のAPIコールを展開すると、APIエンドポイントのパラメータとレスポンスに関する詳細情報が表示されます。

<figure><img src="/files/hf2NBe9VxjusE6gsc1QC" alt=""><figcaption></figcaption></figure>

6. APIエンドポイントをテストするには、**\[Try it out]** ボタンをクリックします。

<figure><img src="/files/u4GvfS4g6Ry5hUMYzDmO" alt=""><figcaption></figcaption></figure>

7. APIパラメータの値を入力したうえで **\[Execute]** をクリックすると、APIコールが実行されます。

<figure><img src="/files/gmhpBrbPBWoOO0z0QzRz" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
APIパラメータとその定義方法の詳細については、[こちらのページ](/enterprise-guide/jp/api-troubleshooting/api-parameters.md)をご参照ください。
{% endhint %}

8. 実行後、レスポンスセクションにスクロールして結果を見ることができます。


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.keeper.io/enterprise-guide/jp/api-troubleshooting/api-explorer-swagger.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.