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キーを選択します。

• user data
• email
• messages
• campaigns
• canvas
• segments
• purchases
• events
• sessions
• kpis
• templates
• sso
• content blocks
• preference center
• subscription
• sms
• catalogs
• sdk authentication

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] までフィードバックをお送りください。