はじめに
連携 / SDK
ユーザー認証
法人確認
トランザクションモニタリング
変更履歴スコープ付きアクセスの導入前に作成されたキーは、引き続きフルアクセスを持ちます。
アクセスを編集するまで、これらのキーのアクセスは変更されません。
キーの確認場所
ビジネスコンソールでアプリケーションを選択し、Developers -> API keysを開きます。 一覧には、アプリケーションのすべてのキーが、ステータス、過去30日間のリクエスト数、作成者、アクセス、最終使用日時とともに表示されます。 キーをクリックすると右側にプレビューが表示されます。また、キーの詳細ページを開くと、使用状況、アクセス、最近のリクエスト、クイックスタート用のスニペット、アクティビティを確認できます。 キーは1つのアプリケーションに属し、そのアプリケーションでのみ機能します。 キーはアプリケーションの環境を引き継ぎます。サンドボックスアプリケーションのキーで、請求対象の認証が作成されることはありません。リダイレクトURLと許可ドメイン
Developers > API keys > Redirects and domainsを開くと、選択中のアプリケーションと環境について2つのリストを設定できます。
許可ドメインリストにエントリがある場合、Create sessionは、そのいずれにも該当しない
callbackを400エラーで拒否します。
リストが空の場合、制限はありません。
サーバー間の呼び出しは影響を受けません。
キーを作成する
1
詳細
キーを使用するサービスにちなんだ名前を付け、有効期限を選択します。無期限、30日、90日、1年、または任意の日付から選べます。
期限切れのキーは、その日の終わり(UTC)に機能しなくなります。
2
アクセス
プリセットから始め、リソースごとに細かく調整します。
キーがこの設定を超える操作を行うことはありません。
3
確認
キーを渡す前に、そのキーでできることとできないことがコンソールに明示されます。
4
シークレットキー
シークレットをコピーし、シークレットマネージャーに保管してください。
シークレット全体が表示されるのはこの1回限りです。
紛失した場合は、キーをローテーションして新しいシークレットを取得してください。
プリセット
リソース
読み取りはリソースに対するGETリクエストを対象とし、書き込みはさらにPOST、PUT、PATCH、DELETEも対象とします。
カスタムアクセスのキーは、公開APIで使用できます。対象はセッション、ユーザー、企業、取引、ワークフロー、Webhookの各エンドポイントと、スタンドアロンチェックです。
Business Consoleのみが使用するエンドポイントは、このキーに対して
403を返します。これらにはフルアクセスのキーが必要です。
メディアの読み取り権限がないキーは、すべての画像、動画、PDFのURLがnullに設定されたセッションの判定を受け取り、PDFレポートのエンドポイントは403を返します。
セッションの書き込み権限がないキーは、セッションの認証リンクやセッショントークンを受け取ることはありません。これらを保持する者は誰でもエンドユーザーとして認証を完了できるためで、これらのフィールドはnullとして返されます。
同じ理由から、send_verification_link: trueでユーザーを作成するには、ユーザーの書き込みに加えてセッションの書き込みも必要です。この操作はセッションを作成し、そのリンクをメールで送信するためです。
この権限がない場合、呼び出しは403を返し、何も作成されません。
制限
一部のワークフローまたは承認済みセッションに制限されたキーは、制限を適用できるセッションのエンドポイントで使用できます。
このキーにユーザー、企業、取引、分析へのアクセス権を付与することはできず、スタンドアロンチェックも実行できません。
スコープ付きキーに対するAPIのレスポンス
セッションの一覧には、キーの制限で許可されたセッションのみが返されます。
アクセス権を編集
キーのメニュー、プレビュー、またはキーのページを開き、アクセス権を編集を選択します。 プリセット、リソース、制限、有効期限を変更し、変更前と変更後の差分のみを確認します。 シークレットは変わらないため再デプロイは不要で、新しいアクセス権は1分以内に適用されます。 プライマリシークレットは常にフルアクセスを持ち、編集できません。キーをローテーションする
ローテーションすると、キーのシークレットが置き換えられます。 新しいシークレットは1回だけ表示され、現在のシークレットは24時間引き続き機能するため、ダウンタイムなしで新しいシークレットをデプロイできます。 その後、古いシークレットを使用したすべてのリクエストは401を返します。
プライマリシークレットも同じ方法で、同じ24時間の併用期間を設けてローテーションされます。
キーを失効させる
失効させると、キーは直ちに無効になり、そのキーで行われたすべてのリクエストは401を返します。
この操作は元に戻せません。
プライマリシークレットは失効させることができないため、代わりにローテーションしてください。