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

# Swaggerをはじめる

Swaggerの始め方

APIキーの設定

API Swaggerを使い始める前に、まずNMKR StudioでAuthentication TokenまたはAPIキーを作成する必要があります。使用するネットワークに応じて、[testnet](https://studio.preprod.nmkr.io/login/)アカウントか[mainnet](https://studio.nmkr.io/login/)アカウントのどちらかで[API Keyを作成](https://docs.nmkr.io/nmkr-studio/account/api-keys)する必要があります。

#### グローバルページ認証

試す前の最初のアクションは、グローバルページの認証パネルにAPIキーを追加することです。これを行わないと、Swagger UIの使用時に必ず401エラーが発生します。

これを行うには、ページの右上に移動し、\[Authorize]ボタンを選択します。するとポップアップが表示されるので、前述の[APIキーを](https://docs.nmkr.io/nmkr-studio/account/api-keys#manage-your-api-keys)コピーして貼り付けます。

<figure><img src="https://content.gitbook.com/content/ZsvBdOVXa49gx1luHNu8/blobs/ytGbQfOgXIEFSaCRAH1g/Screenshot%202022-12-02%20at%2001.06.35.png" alt=""><figcaption></figcaption></figure>

#### ワークフロー例 - お試しください！

**1) エンドポイントの選択**

エンドポイントをクリックすると詳細が表示され、エンドポイントをテストできます。

<figure><img src="https://content.gitbook.com/content/ZsvBdOVXa49gx1luHNu8/blobs/22b5OwkqOsboYB63Y8Gg/Screenshot%202022-12-02%20at%2001.09.55.png" alt=""><figcaption></figcaption></figure>

**2) パネルを起動する**

「Try it out 」をクリックしてパネルを起動します。

<figure><img src="https://content.gitbook.com/content/ZsvBdOVXa49gx1luHNu8/blobs/4t5Da9WMxcp53aczA2j6/Screenshot%202022-12-02%20at%2001.11.52.png" alt=""><figcaption></figcaption></figure>

**3) 要求された詳細を追加する**

認証が要求された場合は、[グローバル認証として](https://docs.nmkr.io/nmkr-studio-api/api-swagger/get-started-with-the-swagger#global-page-authentication)指定したものと同じであることを確認し、「Execute」をクリックしてください。

<figure><img src="https://content.gitbook.com/content/ZsvBdOVXa49gx1luHNu8/blobs/ETuNgZcGYCqddf4KkxKq/Screenshot%202022-12-02%20at%2001.15.02.png" alt=""><figcaption></figcaption></figure>

**4) 回答**

NMKR Studio API は、a) Curl と b) リクエスト URL で応答します。

<figure><img src="https://content.gitbook.com/content/ZsvBdOVXa49gx1luHNu8/blobs/PmTXUxi57KmgbjmXN8Ny/Screenshot%202022-12-02%20at%2001.17.59.png" alt=""><figcaption></figcaption></figure>

また、いくつかのコードで応答します。[Swaggerの応答とエラーコードを](https://docs.nmkr.io/nmkr-studio-api/api-swagger/swagger-responses-and-error-codes)読んで、その意味を理解してください。

以下は、コールが無効であることを示す応答です。

A) invalid; 理由: 「Wallet address already exists（ウォレットアドレスはすでに存在します）」。

<figure><img src="https://content.gitbook.com/content/ZsvBdOVXa49gx1luHNu8/blobs/MKYuXPM0jhvtSSlpniec/Screenshot%202022-12-02%20at%2001.21.41.png" alt=""><figcaption></figcaption></figure>

B) 有効であり、実行されました。

<figure><img src="https://content.gitbook.com/content/ZsvBdOVXa49gx1luHNu8/blobs/Z2Lg2Nh46F1SGFTstKAH/Screenshot%202022-12-02%20at%2001.23.51.png" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
ペイロードにメタデータをアップロードする場合は、メタデータをエスケープする必要があることに留意してください。

[オンラインJSONエスケープ/Unescapeツールhttps://www.freeformatter.com/json-escape.html#before-output](https://www.freeformatter.com/json-escape.html#before-output)
{% endhint %}