Skip to content

APIの概要

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

Braze REST APIコレクション

API定義

Braze REST API のドキュメントで使用される用語の概要を次に示します。

エンドポイント

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

API制限

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

ユーザー ID

  • External user ID:external_id は、データの送信対象となる一意のユーザー識別子として機能します。この識別子は、同じユーザーに複数のプロファイルが作成されるのを避けるため、Braze SDK で設定したものと同じでなければなりません。
  • BrazeユーザーID：braze_id は、Brazeが設定する固有のユーザー識別子の役割を果たす。この識別子は、external_idsに加えて、REST APIを通じてユーザーを削除するために使用できる。

詳細については、iOS、Android、Webの各プラットフォームに応じた以下の記事を参照のこと。

REST APIキーについて

REST Application Programming Interface キー （REST APIキー） は、API 呼び出しを認証し、呼び出し元のアプリケーションまたはユーザーを識別するために API に渡される一意のコードです。APIアクセスは、御社のREST APIエンドポイントへのHTTPSウェブリクエストを使って行われる。Brazeでは、REST APIキーをApp Identifierキーと組み合わせて使用し、データの追跡、アクセス、送信、エクスポート、分析を行い、お客様とBrazeの両エンドですべてがスムーズに進むようサポートする。

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

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

![API KeysタブのREST APIキーパネル。][27]

REST APIキーを作成する

新しいREST APIキーを作成する：

  1. [設定] ＞ [API と識別子] に進みます。

2.[API キーを作成] を選択します。 3.一目で識別できるように、新しいキーに名前をつける。 4.新しいキーに対して許可リストに登録済みの IPアドレスとサブネットを指定します。

  1. 新しいキーに関連付ける権限を選択します。

REST APIキーのパーミッション

APIキーのパーミッションは、特定のAPIコールへのアクセスを制限するために、ユーザーまたはグループに割り当てることができるパーミッションである。APIキーの権限のリストを表示するには、設定>APIと識別子と進み、APIキーを選択する。

REST API キーを管理する

設定＞APIと識別子＞APIキータブから、既存のREST APIキーの詳細を見たり、削除したりできる。REST APIキーは、作成後に編集することはできない。

APIキー]タブには、各キーについて以下の情報が含まれている：

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

![][30]

ユーザーを削除しても、そのユーザーが作成したAPIキーは削除されない。キーを削除するには、キーにカーソルを合わせ、 Deleteを選択する。

![][29]{: style=”max-width:30%;”}

REST APIキーのセキュリティ

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

REST API キーによって潜在的に機密性の高い REST API エンドポイントへのアクセスが許可される場合は、これらのキーをセキュリティで保護し、信頼できるパートナーとのみ共有します。これらのキーは一般公開しないでください。例えば、このキーを使ってウェブサイトからAJAXコールを行ったり、その他の一般的な方法で公開したりしてはならない。

適切なセキュリティープラクティスは、ジョブを完了するために必要なアクセス権のみをユーザーに割り当てることです。この原則は、各キーに権限を割り当てることによって API キーにも適用できます。これらのアクセス許可により、セキュリティが向上し、アカウントのさまざまな領域をコントロールできます。

キーが誤って公開された場合は、開発者コンソールから削除できます。このプロセスに関するヘルプについては、[サポートチケット] [サポート] を開きます。

API IP の許可リスト

セキュリティをさらに強化するため、特定の REST API キーに対して REST API 要求を実行できる IP アドレスやサブネットのリストを指定できます。これは、許可リストまたはホワイトリストと呼ばれます。特定のIPアドレスやサブネットを許可するには、新しいREST APIキーを作成する際に、Whitelist IPsセクションに追加する：

APIキーの作成時にIPのリストを許可するオプション。

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

その他のリソース

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

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

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

[support] ： /docs/ja/braze_support/ [28]: /docs/ja/assets/img_archive/create-new-key.png?c946be26e03a7d399c1ee05bbbf811d9 [29]: /docs/ja/assets/img_archive/api-key-options.png?8ed31146d679baf4a4a5974ad8c17923 [27]: /docs/ja/assets/img_archive/rest-api-key.png?842dc6972dfb265bb1753e6f4f1b138f [30]: /docs/ja/assets/img_archive/view-api-key.png?3d0fa48c855271f5f64687315bc1c955

Github   GitHub でこのページを編集
「このページはどの程度役に立ちましたか?」
New Stuff!