APIキーを使用すると、アプリケーションはBitcoinVNアカウントの一部にアクセスできます。各キーはパスワードと同じように扱ってください。キーを入手した人は、アカウント情報を閲覧したり、その権限で許可された操作を実行したりできる可能性があります。
キーを作成してラベルを付ける
キーを作成する前に、対象のメインアカウントまたはVIPサブアカウントが有効になっていることを確認してください。
次に：
- APIキー管理を開きます。
- 新しいキーを生成を選択します。
- キーを使用するアプリケーションにコピーします。
- 編集を選択します。
- アプリケーションや用途が分かるラベルを追加します。
- 権限と任意のIP制限を選択し、保存します。
アプリケーションごとに別のキーを使用すると、他に影響を与えずに1つの連携を制限または取り消せます。ラベルに秘密情報や個人情報を含めないでください。
必要最小限の権限を選ぶ
BitcoinVNには2つの権限レベルがあります。
- 読み取り専用：アカウントデータを閲覧できますが、注文は作成できません。
- 読み取りと書き込み：アカウントデータを閲覧し、注文を作成できます。
読み取りと書き込み権限を持つキーは、アカウント残高を使用して注文を作成し、受取先へ代金を送ることができます。このようなキーを入手した人は、資金を引き出せる可能性があります。
アプリケーションが本当に注文を作成する必要がない限り、読み取り専用アクセスを使用してください。
IPアドレスでアクセスを制限する
編集ページでキーを特定のIPアドレスに制限できます。
- 1行に1つのIPアドレスを入力します。
- 対象のアプリケーションが使用するアドレスだけを追加します。
- アプリケーションが固定IPアドレスを使用できない場合に限り、空欄にします。
IP制限が設定されている間、他のアドレスからのリクエストは受け付けられません。アプリケーションのアドレスが変わった場合はリストを更新してください。
APIでキーを使用する
キーをX-API-KEYリクエストヘッダーで送信します。
X-API-KEY: <your-api-key>上記のプレースホルダーは例にすぎません。実際のキーを公開コード、スクリーンショット、サポートメッセージ、ブラウザ側のアプリケーション、URL、ログに含めないでください。
インタラクティブAPIドキュメントはbitcoinvn.io/api/docで確認できます。
サブアカウントのコンテキストを理解する
APIキーは、作成時に有効だったアカウントに関連付けられたままです。
- メインアカウントで作成したキーはメインアカウントを使用します。
- サブアカウントが有効な状態で作成したキーはそのサブアカウントを使用します。
ウェブサイトでアカウントを切り替えても既存のキーは変わりません。生成前に有効なアカウントを確認してください。
キーを取り消す、または交換する
APIキー管理を開き、不要なキーの横にある取り消すを選択します。取り消しは元に戻せません。
キーが漏洩した可能性がある場合：
- キーを取り消します。
- 交換用のキーを生成します。
- 必要な権限とIP制限を設定します。
- 対象のアプリケーションを更新します。
APIキーをBitcoinVNサポートやBitcoinVNの関係者を名乗る人に送らないでください。