Swaggerをはじめる

Swaggerの始め方

APIキーの設定

API Swaggerを使い始める前に、まずNMKR StudioでAuthentication TokenまたはAPIキーを作成する必要があります。使用するネットワークに応じて、testnetアカウントかmainnetアカウントのどちらかでAPI Keyを作成する必要があります。

グローバルページ認証

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

これを行うには、ページの右上に移動し、[Authorize]ボタンを選択します。するとポップアップが表示されるので、前述のAPIキーをコピーして貼り付けます。

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

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

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

2) パネルを起動する

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

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

認証が要求された場合は、グローバル認証として指定したものと同じであることを確認し、「Execute」をクリックしてください。

4) 回答

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

また、いくつかのコードで応答します。Swaggerの応答とエラーコードを読んで、その意味を理解してください。

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

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

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

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

オンラインJSONエスケープ/Unescapeツールhttps://www.freeformatter.com/json-escape.html#before-output

最終更新