メインコンテンツへスキップ
GetQR API はベータ版で、一部のワークスペースでのみご利用いただけます。正式リリースまでに内容が変更される場合があります。
GetQR API は、すべてのリクエストをアカウントの API キーで認証します。キーはユーザーごとに 1 つで、1 つのワークスペースであなたとして動作します。

​
始める前に

  • ワークスペースのオーナーまたは編集者である必要があります。閲覧者は API キーを作成することも使うこともできません。
  • ワークスペースのオーナーに有効なサブスクリプションが必要です。

​
API キーを作成する

1

アカウント設定を開く

アカウント設定を開き、API に移動します。
2

キーを生成する

Generate API key をクリックします。
3

キーをコピーする

キーを表示してコピーします。キーは sk_live_ で始まります。
キーはいつでも再表示してコピーできます。設定画面には、キーの作成日時と最終使用日時も表示されます。

​
リクエストを認証する

すべてのリクエストの Authorization ヘッダーで、キーを Bearer トークンとして送ります。
キーなしで使えるエンドポイントは ヘルスチェック だけです。

​
アクセスと役割

  • 役割。 API キーを作成して使えるのは、ワークスペースのオーナーと編集者だけです。閲覧者は使えません。
  • ワークスペース。 各キーは 1 つのワークスペースに属し、すべてのリクエストはそのワークスペースで実行されます。ワークスペース ID を渡す必要はありません。
  • リクエストごとの確認。 アクセス権は、リクエストのたびに現在の役割とワークスペースのオーナーのサブスクリプションに基づいて確認されます。あなた自身のサブスクリプションは関係ありません。役割が閲覧者に変わったり、オーナーのサブスクリプションが終了したりすると、アクセスが回復するまでリクエストは 403 を返します。新しいキーは不要です。
  • 削除。 ワークスペースから削除されると、API キーも削除されます。再度追加された場合は、新しいキーを生成してください。

​
キーを再生成する

キーが漏えいした場合や、持つべきでない人がアクセスできるようになった場合は、キーを再生成します。
現在のキーはすぐに使えなくなります。そのキーを使っているアプリや連携は、新しいキーに更新するまで動作しません。
1

Regenerate をクリックする

アカウント設定で API に移動し、Regenerate をクリックします。
2

確認する

Regenerate key をクリックします。
3

アプリを更新する

新しいキーをコピーし、古いキーを使っているすべての場所で置き換えます。

​
キーを安全に保管する

キーはパスワードと同じように扱ってください。キーを持っている人は誰でも、ワークスペースの QR コードを作成、変更、削除できます。
  • キーはソースコードではなく、環境変数またはシークレットマネージャーに保存します。
  • API はサーバーからのみ呼び出します。Web サイト、モバイルアプリなど、ユーザーが中身を調べられる場所には決してキーを置かないでください。
  • キーは必要な開発者とだけ共有します。
  • 漏えいが疑われたら、すぐに再生成します。

​
よくある問題

キーが再生成されたか、ワークスペースから削除されてキーも削除されました。アカウント設定から現在のキーをコピーするか、新しいキーを生成してください。
役割がオーナーまたは編集者であること、ワークスペースのオーナーのサブスクリプションが有効であることを確認してください。アクセスが回復すると、キーはすぐにまた使えるようになります。
API はベータ版で、あなたのワークスペースではまだ有効になっていません。
API の設定は、ワークスペースのオーナーと編集者にのみ、API が有効なワークスペースでのみ表示されます。

​
次のステップ

API の概要

エラー