メインコンテンツまでスキップ

APIキー

APIキーは、APIへのアクセスを制御し、APIとの相互作用を監視するための識別、認証、および認可の形式として機能します。これにより、承認されたユーザーとアプリケーションのみが、さまざまなサービスやリソースに対して特定のアクションを実行できるようになります。

APIキーはユーザーアカウントにスコープされます。ユーザーのアカウントを削除すると、そのAPIキーも直ちに取り消されます。APIキーには、関連するユーザーがアクセスできるグループの制限まで、グループへのアクセスを許可できます。

APIキーの作成​

APIキーを生成するには：

  1. ナビゲーションバーで、Admin、次にAPI Keysの順に移動します。または、APIキーのスコープを自分のものに限定するには、ユーザーアイコンをクリックし、次にMy API Keysをクリックします。
  2. New Keyボタンをクリックします。

apikey-page

  1. キーの意図された用途を反映する説明的な名前を入力します。キーを使用できるGroupsを選択し、Create Keyをクリックします。

または、Use this key as a public Web3 keyを選択します。これはCurvegrid Testnetにのみ適用され、MetaMaskなどのweb3ウォレット、またはHardhatやFoundry Forgeなどのサードパーティweb3ツールを構成するのに適したエンドポイントとAPIキーを提供します。

apikey-create

⚠️ APIキーは機密情報であり、セキュリティ上の理由から、作成後は表示されませんのでご注意ください。APIキーを紛失または忘れた場合は、新しいものを生成する必要があります。

api-save

APIキーの取り消し​

APIキーを取り消す（削除する）には、取り消したいキーの横にあるゴミ箱アイコンをクリックします。ポップアップダイアログで決定を確認します。注意：このアクションは永続的であり、元に戻すことはできません。

apikeys-revoke

APIキーの編集​

APIキーの名前を編集するには、キーの名前の横にある鉛筆アイコンをクリックし、変更を行い、確認します。

apikeys-edit

APIキーの使用​

APIキーを使用するには、MultiBaaSへのHTTPリクエストのAuthorizationヘッダーにベアラートークンとして含めます。以下は、APIキーの使用を示すcurlコマンドのサンプルです：

curl -X POST 'https://your-deployment.multibaas.com/api/v1/contract' \
     -H 'Content-Type: application/json' \
     -H 'Authorization: Bearer ${YOUR_API_KEY}' \
     -d '{...}'

${YOUR_API_KEY}を実際のAPIキーに、your-deployment.multibaas.comをMultiBaaSデプロイメントURLに置き換えてください。

セキュリティに関する考慮事項​

  • APIキーはパスワードと同じように扱ってください。公開リポジトリ、ログ、その他の安全でない場所で共有または公開されるべきではありません。唯一の例外は、MultiBaaSと直接連携させるためにフロントエンドコードに埋め込む可能性のあるDApp User APIキーです。
  • アクセスと制御をより適切に管理するために、各統合に個別のAPIキーを使用してください。
  • セキュリティリスクを最小限に抑えるために、不要になったAPIキーを定期的に確認および取り消してください。