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呼び出しを認証し、呼び出し元のアプリケーションやユーザーを識別するための一意のコードです。HTTPS Webリクエストを使用して、会社のREST APIエンドポイントにアクセスします。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キーに加えて、識別子キーと呼ばれるキータイプも存在します。これは、アプリ、テンプレート、キャンバス、キャンペーン、Content Cards、セグメントなどの特定のリソースをAPIから参照するために使用できます。詳細については、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ホワイトリストにオプトインしているかどうかが含まれます。

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

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