> 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エクスプローラ <a href="#api-explorer-with-swagger" id="api-explorer-with-swagger"></a>

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="https://3468650114-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeJwa6ByNJ2qindnPknCW%2Fuploads%2FYZ25LaqrvZtzPtLMgT8D%2Fswagger1.png?alt=media&amp;token=8666d1ac-70ad-45fe-9e9d-76cbac833fed" alt=""><figcaption><p>この例では、ファミリープランのYAMLファイルを使用します。</p></figcaption></figure>

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

<figure><img src="https://3468650114-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeJwa6ByNJ2qindnPknCW%2Fuploads%2FMio4Duz8MOZdlBSXiVRN%2Fswagger2.png?alt=media&amp;token=54dc2272-19d2-49b0-a554-d6dd49cd13b4" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://3468650114-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeJwa6ByNJ2qindnPknCW%2Fuploads%2FgWxFl4hZM9VXFNY71Bdl%2Fswagger3.png?alt=media&amp;token=3252253e-a848-4a96-8efb-1f578a15a088" alt=""><figcaption></figcaption></figure>

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

<figure><img src="https://3468650114-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeJwa6ByNJ2qindnPknCW%2Fuploads%2Fv8Lk9WdYG0UFG5YiM81Z%2Fswagger4.png?alt=media&amp;token=115ee658-5461-4d3c-9033-24a8c30ba47c" alt=""><figcaption></figcaption></figure>

8. 実行後、レスポンスセクションまでスクロールして結果を確認できます。

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


---

# 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.keeper.io/enterprise-guide/jp/api-troubleshooting/api-explorer-swagger.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.
