APIの概要

このリファレンス記事では、一般的な用語、REST APIキーや権限の概要、それらを安全に保つ方法など、APIの基本について説明します。

Braze REST APIコレクション

API の定義

以下は、Braze REST API ドキュメントで使用される用語の概要です。

エンドポイント

Braze は、ダッシュボードと REST エンドポイント用に複数の異なるインスタンスを管理しています。アカウントがプロビジョニングされると、以下の URL のいずれかにログインします。プロビジョニングされたインスタンスに基づいて、正しい REST エンドポイントを使用してください。不明な場合は、サポートチケットを開くか、以下の表を使用して、使用しているダッシュボードの URL を正しい REST エンドポイントと照合してください。

Braze で REST エンドポイントを確認するには:

1. Braze にログインし、設定 > API と識別子 > API キーに移動します。
2. 既存の API キーを選択するか、API キーを作成を選択して新しいキーを作成します。
3. このタブに表示される REST エンドポイントをコピーし、API リクエストに使用します。

重要

API コールにエンドポイントを使用する場合は、REST エンドポイントを使用してください。

SDK 統合には、REST エンドポイントではなくSDKエンドポイントを使用してください。

API の制限

ほとんどの API について、Braze では1時間あたり250,000リクエストのデフォルトレート制限が設定されています。ただし、特定のリクエストタイプには、顧客ベース全体の大量データをより適切に処理するために独自のレート制限が適用されます。詳細については、API レート制限を参照してください。

ユーザー ID

• external ID: external_idは、データを送信する対象のユーザーを一意に識別するものです。この識別子は、同一ユーザーに対して複数のプロファイルが作成されることを防ぐため、Braze SDKで設定したものと同じである必要があります。
• Braze ユーザー ID: braze_idは、Braze が設定する一意のユーザー識別子です。この識別子を使用して、external_id に加えて REST API 経由でユーザーを削除できます。

詳細については、プラットフォームに応じて以下の記事を参照してください: iOS、Android、Web。

REST APIキーについて

REST API (REST Application Programming Interface) キーは、APIに渡してAPI呼び出しを認証し、呼び出し元のアプリケーションやユーザーを識別するための一意のコードです。APIへのアクセスは、会社のREST APIエンドポイントへのHTTPS Webリクエストを使用して行います。REST APIキーはアプリ識別子キーと連携して、データのトラッキング、アクセス、送信、エクスポート、分析を行い、すべてがスムーズに動作していることを確認します。

ワークスペースとAPIキーはBrazeにおいて密接に連動しています。ワークスペースは、同じアプリケーションの複数プラットフォームにわたるバージョンを管理するように設計されています。多くのお客様は、同じプラットフォーム上の無料版とプレミアム版のアプリケーションを格納するためにもワークスペースを使用しています。お気づきかもしれませんが、これらのワークスペースもREST APIを利用しており、独自のREST APIキーを持っています。これらのキーは、API上の特定のエンドポイントへのアクセスを含むように個別にスコープを設定できます。APIへの各呼び出しには、対象のエンドポイントへのアクセス権を持つキーを含める必要があります。

REST APIキーとワークスペースAPIキーの両方をapi_keyと呼びます。api_keyは各リクエストにリクエストヘッダーとして含まれ、REST APIの使用を許可する認証キーとして機能します。これらのREST APIは、ユーザーのトラッキング、メッセージの送信、ユーザーデータのエクスポートなどに使用されます。新しいREST APIキーを作成する際には、特定のエンドポイントへのアクセス権を付与する必要があります。APIキーに特定の権限を割り当てることで、そのAPIキーが認証できる呼び出しを正確に制限できます。

ヒント

REST APIキーに加えて、APIからアプリ、テンプレート、キャンバス、キャンペーン、Content Cards、セグメントなどの特定の要素を参照するために使用できる識別子キーと呼ばれるタイプのキーも存在します。詳細については、API識別子タイプを参照してください。

REST APIキーの作成

新しいREST APIキーを作成するには:

1. 設定 > APIと識別子に移動します。
2. APIキーを作成を選択します。
3. 一目で識別できるように新しいキーに名前を付けます。
4. 新しいキーの許可リストに登録するIPアドレスとサブネットを指定します。
5. 新しいキーに関連付ける権限を選択します。

重要

新しいAPIキーを作成した後は、権限のスコープや許可リストに登録されたIPを編集できないことにご注意ください。この制限はセキュリティ上の理由から設けられています。キーのスコープを変更する必要がある場合は、更新された権限で新しいキーを作成し、古いキーの代わりにそのキーを実装してください。実装が完了したら、古いキーを削除できます。

REST APIキーの権限

APIキーの権限は、ユーザーまたはグループに割り当てて、特定のAPI呼び出しへのアクセスを制限できる権限です。APIキーの権限一覧を表示するには、設定 > APIと識別子に移動し、APIキーを選択します。

• ユーザーデータ
• メール
• メッセージ
• キャンペーン
• キャンバス
• セグメント
• 購入
• イベント
• セッション
• kpis
• テンプレート
• sso
• content blocks
• ユーザー設定センター
• 購読
• sms
• カタログ
• sdk認証

REST APIキーの管理

既存のREST APIキーの詳細を表示したり削除したりするには、設定 > APIと識別子 > APIキータブに移動します。REST APIキーは作成後に編集できないことにご注意ください。

APIキータブには、各キーについて以下の情報が表示されます。

APIキーの詳細を表示するには、キーにカーソルを合わせて 表示を選択します。ここには、このキーが持つすべての権限、ホワイトリストに登録されたIP（ある場合）、およびこのキーがBraze IPホワイトリストにオプトインしているかどうかが含まれます。

ユーザーを削除しても、Brazeはそのユーザーが作成した関連APIキーを削除しないことにご注意ください。キーを削除するには、キーにカーソルを合わせて 削除を選択します。

REST APIキーのセキュリティ

APIキーはAPI呼び出しの認証に使用されます。新しいREST APIキーを作成する際には、特定のエンドポイントへのアクセス権を付与する必要があります。APIキーに特定の権限を割り当てることで、そのAPIキーが認証できる呼び出しを正確に制限できます。

REST APIキーは潜在的に機密性の高いREST APIエンドポイントへのアクセスを許可するため、これらのキーを安全に保管し、信頼できるパートナーとのみ共有してください。公開してはなりません。例えば、このキーを使用してWebサイトからAJAX呼び出しを行ったり、その他の公開的な方法で公開したりしないでください。

良いセキュリティプラクティスは、ユーザーに業務遂行に必要な最小限のアクセス権のみを割り当てることです。この原則は、各キーに権限を割り当てることでAPIキーにも適用できます。これらの権限により、アカウントのさまざまな領域に対するセキュリティと制御が向上します。

警告

REST APIキーは潜在的に機密性の高いREST APIエンドポイントへのアクセスを許可するため、安全に保管し使用してください。例えば、このキーを使用してWebサイトからAJAX呼び出しを行ったり、その他の公開的な方法で公開したりしないでください。

誤ってキーを公開してしまった場合は、開発者コンソールから削除できます。このプロセスについてサポートが必要な場合は、サポートチケットを開いてください。

REST APIキーとSDK APIキーのセキュリティ

REST APIキーとSDK APIキーにはそれぞれ異なるセキュリティプロファイルがあります。

API IP許可リスト

セキュリティを強化するために、特定のREST APIキーに対してREST APIリクエストの送信を許可するIPアドレスとサブネットのリストを指定できます。これは許可リスト（ホワイトリスト）と呼ばれます。特定のIPアドレスまたはサブネットを許可するには、新しいREST APIキーの作成時にホワイトリストIPセクションに追加します。

何も指定しない場合、任意のIPアドレスからリクエストを送信できます。

ヒント

Braze間のwebhookを作成し許可リストを使用している場合は、ホワイトリストに登録するIPのリストを参照してください。

API認証とセキュリティ

Bearerトークン認証

Brazeは、AuthorizationリクエストヘッダーにBearerトークンとして渡されたREST APIキーを使用してREST APIリクエストを認証します。リクエストを送信する際は、以下の形式でAPIキーを含めてください。

1
Authorization: Bearer YOUR_REST_API_KEY

各リクエストに対して、Brazeは以下のサーバー側の検証チェックを実行します。

1. トークンの有効性： REST APIキーがBrazeに存在し、アクティブであること（たとえば、取り消されたり無効化されていないこと）を確認します。
2. トークンの認可： APIキーがリクエストされたエンドポイントに必要な権限を持っていることを確認します。

認証に失敗した場合、APIはHTTPステータスコードを含むエラーレスポンスを返します。たとえば、401 Unauthorizedは無効なキーまたはキーの欠落を示し、403 Forbiddenはキーがリクエストされたエンドポイントに対する権限を持っていないことを示します。詳しくはAPIエラーを参照してください。

リクエストヘッダーの大文字小文字

HTTPヘッダー名は大文字小文字を区別しないため、Authorizationとauthorizationは同等です。Content-Typeなどの他の標準リクエストヘッダーにも同じことが当てはまります。お使いのHTTPクライアントが生成する任意の大文字小文字で送信してください。

BrazeはBearerスキームの任意の大文字小文字（Bearer、bearer、BEARER）も受け付けます。REST APIキー自体は、発行されたとおりに正確に送信してください。

ネットワークレベルのセキュリティ

BrazeへのREST APIリクエストは、リクエストパス全体にわたってTransport Layer Security（TLS）暗号化によって保護されます。以下の表は、サーバーからBrazeへのAPIリクエストのネットワークフローを示しています。

TLS暗号化はチェーン内のすべてのリンクをカバーします。お客様のサーバーはTLSを介してCloudflareに接続し、CloudflareはNLBを経由してNGINXイングレスへの別のTLS接続を確立するため、APIキーとリクエストデータは転送中も暗号化された状態を維持します。

その他のリソース

Ruby クライアントライブラリ

Ruby を使用して Braze を実装している場合、Ruby クライアントライブラリを使用してデータインポート時間を短縮できます。クライアントライブラリとは、特定のプログラミング言語（この場合は Ruby）に固有のコードの集まりであり、APIの使用を容易にするものです。

Ruby クライアントライブラリはユーザーエンドポイントをサポートしています。

重要

このクライアントライブラリはベータ版です。このライブラリの改善にご協力いただける場合は、[email protected] までフィードバックをお送りください。