開発者向けに UniSat API キーを取得するにはどうすればよいですか? (開発者ツール)

UniSat 開発者ポータルへのアクセス

1. UniSat の公式 Web サイトに移動し、メイン ナビゲーション メニューで「開発者」または「API」セクションを見つけます。

2. 「開発者ツール」または「API ドキュメント」というラベルのリンクをクリックすると、専用のサブドメインまたはパス ( https://dev.unisat.ioなど) にリダイレクトされます。

3. ポータルはアカウントの作成とキーの生成にセッションベースの認証を使用しているため、ブラウザーがサードパーティ Cookie をブロックしていないことを確認します。

4. UniSat ウォレット拡張機能をまだインストールしていない場合は、続行する前に Chrome Web ストアまたは Firefox アドオンからダウンロードしてセットアップします。

5. UniSat ウォレットを使用してサインインします。システムは、電子メール/パスワード認証情報ではなく、暗号化署名チャレンジを通じて所有権を検証します。

アプリケーションの登録

1. 認証されたら、開発者ダッシュボード内の「アプリケーション」タブに移動します。

2. 「+ 新しいアプリケーション」ボタンをクリックして登録を開始します。

3. 「Bitcoin NFT Explorer」や「Ordinal Indexer Bot」など、プロジェクトのわかりやすい名前を入力します。

4. 有効なコールバック URL を指定します。これは、UniSat が登録確認などのイベントの Webhook 通知を送信できる HTTPS エンドポイントである必要があります。

5. アプリケーションに必要な権限を選択します: ブロックチェーン データへの読み取り専用アクセス、碑文メタデータの取得、または完全なウォレット インタラクション機能。

API キーの生成と管理

1. 申請フォームを送信すると、UniSat は一意のクライアント ID を生成し、それを秘密の API キーとともに使い捨てモーダル ウィンドウに表示します。

2. 両方の値をすぐにコピーします。秘密キーは最初の表示後にマスクされ、インターフェースから再度取得することはできません。

3. 秘密キーを安全な環境変数またはボールトに保存します。フロントエンド コードまたはパブリック リポジトリでそれを公開すると、アプリケーションのセキュリティが危険にさらされます。

4. /v1/inscriptionsや/v1/transactionsなどのエンドポイントに対して HTTP リクエストを行うときは、クライアント ID をX-Client-IDヘッダーとして使用し、秘密キーをX-API-Keyヘッダーとして使用します。

5. アプリケーションの設定にある「キーの取り消し」オプションを使用して、侵害されたキーを取り消します。取り消しは、すべての UniSat インフラストラクチャ ノードにわたって 60 秒以内に有効になります。

レート制限と使用制限

1. 無料枠アプリケーションは1 時間あたり 1,000 リクエストに制限され、バーストの上限は 1 分あたり 100 リクエストです。

2. 各 API キーは特定のアプリケーション ID にバインドされています。複数の登録済みアプリ間で 1 つのキーを使用しようとすると、自動調整がトリガーされます。

3. HTTP ステータス 429 を返すリクエストは、現在のレート制限を超えていることを示します。応答には、次に許可される呼び出しまでの秒数を指定するRetry-Afterヘッダーが含まれます。

4. 500 エントリを超える碑文リストのフェッチなどの一括操作には、ページネーション パラメータ ( limitおよびoffset ) が必要です。これらを省略すると、応答が切り詰められます。

5. API によって返されるすべてのタイムスタンプは、UTC タイムゾーンを含む ISO 8601 形式に従い、ブロックの高さの値は確認された Bitcoin メインネット ブロックのみを反映します。

よくある質問

Q: 複数のドメイン間で同じ UniSat API キーを使用できますか? A: いいえ。各ドメインはアプリケーションのセットアップ時に明示的に登録する必要があります。クロスドメインの使用により CORS 拒否がトリガーされ、バックエンド サービスに到達する前にリクエストが無効になります。

Q: UniSat はダウンタイムなしの API キーのローテーションをサポートしていますか? A: はい。古いキーがアクティブなまま新しいキーを生成し、サービス構成を更新し、検証で安定した動作が確認されたら、以前のキーを取り消します。

Q: テストネットの登録には実稼働 API 経由でアクセスできますか? A: いいえ。本番 API はメインネット データのみを提供します。別のテストネット エンドポイントがhttps://testnet-api.unisat.ioに存在し、独自のアプリケーション登録とキーが必要です。

Q: アプリケーションが 1 日のクォータしきい値を超えた場合はどうなりますか? A: リクエストは HTTP 403 Forbidden で失敗し、ゼロを示すX-RateLimit-Remainingヘッダーが含まれています。クォータは、使用パターンに関係なく、UTC 午前 0 時にリセットされます。