APIを使い始める

NMKR Studio APIを使い始める

APIを使う

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

リクエストの大半は、以下の要素の一部（またはすべて）を使用します：

ベースURI、で構成される：
ウェブアドレス
APIバージョン
方法名
プロジェクトUID
NFT UID
NFTカウント
JSONペイロード
リクエスト元IPアドレス
その他の特定方法データ
リクエスト・ヘッダのBEARER TOKENとしてのAPIキー

ほとんどの一般的な言語を使用して、コンピューターからAPIコールを実行することができますが、ウェブサイトのユーザーに呼び出させることを計画している場合は、サーバーフロントエンド/バックエンドの原則を使用してウェブサイトを確実にセットアップする必要があります。その理由は、ほとんどのブラウザがフロントエンドのUIからAPIコールを行おうとすると、単にブロックしてしまうからです（CORS Policy Error）。

注意 - プロジェクトおよびNFTのUIDは、予測できないランダムな文字列になり、この追加のセキュリティ機能は、攻撃者がIDを「推測」できないことを意味し、APIキーが侵害された場合でも特定の攻撃をより困難にします。

注意 - APIキーは絶対に公開しないでください。もし公開した場合は、すぐに削除して新しいものを作成してください。

API URLテストネット(preprod)とメインネット

テストネット（prepod）API

https://studio-api.preprod.nmkr.io/v2/

メインネットAPI

https://studio-api.nmkr.io/v2/

CURLの例

curl -X 'GET' \
  'https://studio-api.nmkr.io/v2/endpoint/aaaaaaa-bbbb-cccc-dddd-eeeeeeeeee' \
  -H 'accept: text/plain' \
  -H 'Authorization: Bearer xxxxxxxxxxxxxxxxxxxxxxx'

APIの使い方を学ぶ

APIエンドポイントをDAppやウェブサイトに実装する前に、 API Swaggerでテストしてみると良いでしょう。API Swaggerは Testnetだけでなく Mainnetでも利用できます。

Swagger UI

APIをテストするもう一つの非常に便利なツールはPostmanです。Postmanは、開発者がAPIを設計、構築、テスト、反復するためのAPIプラットフォームです。

Postman

APIテンプレートと例

また、NMKR Studio APIの最も一般的な回避策や機能のAPI例とテンプレートも提供しています。

前へAPI機能次へAPI Swagger

最終更新 1 年前