イベント API は、イベント、セッション、セッション トラック、パス、講演者、スポンサー シップからのデータにアクセスするためのプログラムによる方法です。 さらに、イベント API を使用すると、イベントとセッションに登録できます。
アクセスされる API は HTTPS プロトコル経由であり、Web アプリケーション トークンの作成中に受信した API エンドポイントからアクセスされます。 すべてのデータは JSON として送受信されます。
イベント API に登録する
[ 設定] セクションの [ イベント管理>Web アプリケーション] で、新しい Web アプリケーションを作成します。 正しい原産地を選択することが重要です。 たとえば、https://contoso.com異なるドメインでホストされている JavaScript は、イベント管理 API にアクセスできません。
Web アプリケーションを作成すると、エンドポイント ドキュメント (プレビュー) に OpenAPI 仕様へのリンクが表示されます。
リンクを選択し、API コントラクトをコピーして Swagger エディターなどの OpenAPI エディターに貼り付けることができます。これにより、API の検出に使用できるラッパーが自動的に事前に生成されます。 API にアクセスするには、承認を受ける必要があります (トークン 列)。
イベント ページまたはイベント ポータルを作成する
イベント API を使用すると、"イベント API を使用したカスタム ソリューション" 発行オプションを使用して、ライブおよび発行されたすべての使用可能なイベントを一覧表示する、カスタマイズされたイベント ページとイベント ポータルを作成できます。 イベント API を使用すると、次のことができます。
- 名前、説明、場所、時刻を含むライブ イベントの一覧を取得します。
- イベント ページでは、次のようなイベントに関する重要な情報を取得できます。
- 名前
- 時間
- 場所
- イベント QR コード
- キャパシティ
- セッションの一覧
- スピーカーの一覧
- スポンサーとそのロゴの一覧
カスタム イベント登録エクスペリエンスを作成する
イベント API を使用すると、リアルタイムのマーケティング フォームを使用せずに登録申請を作成することもできますが、照合戦略、同意、対象ユーザー設定などの重要な機能の恩恵を受けることができます。
まず、
- 既定の対象ユーザー
- 既定の一致ルール
- 既定のコンプライアンス プロファイル
既定のイベント登録設定は、API からの送信を処理するときに使用されます。 登録設定を設定すると、イベント API 送信エンドポイントで次のことができます。
- イベントの登録申請を作成します。
{
"attendees": [
{
"lastName": "Sample Contact Last Name",
"firstName": "Sample Contact First Name",
"email": "email@contoso.com",
"responses": [
{
"id": "jobtitle",
"value": "Sample Contact Job Title"
},
{
"id": "customUnmappedField1",
"value": "Sample Custom Unmapped Field 1"
},
{
"id": "customUnmappedField2",
"value": "Sample Custom Unmapped Field 2"
}
]
}
]
}
- セッションの登録申請を作成します。
{
"attendees": [
{
"lastName": "Sample Contact Last Name",
"firstName": "Sample Contact First Name",
"email": "email@contoso.com",
"responses": [
{
"id": "jobtitle",
"value": "Sample Contact Job Title"
}
],
"attendeeSessions": [
{
"sessionId": "d5f513c6-989f-f011-bbd3-000d3a5b6385"
},
{
"sessionId": "f5d4e4b9-989f-f011-bbd3-000d3a5b6385"
}
]
}
]
}
- 待機リスト登録を作成します。
{
"attendees": [
{
"lastName": "Sample Contact Last Name",
"firstName": "Sample Contact First Name",
"email": "email@contoso.com",
"waitlisted": true,
"responses": [
{
"id": "jobtitle",
"value": "Sample Contact Job Title"
},
{
"id": "customUnmappedField1",
"value": "Sample Custom Unmapped Field 1"
},
{
"id": "customUnmappedField2",
"value": "Sample Custom Unmapped Field 2"
}
]
}
]
}
パフォーマンスと制限
イベント API では、非同期処理、スマート キャッシュ、組み込みの再試行ロジックを使用して、大量の登録シナリオがサポートされます。
登録要求がイベント API を介して到着すると、 システムは次の処理を行います。
- イベントがアクティブであり、すべての関連エンティティが有効な状態であることを検証します
- 呼び出し元に対する即時の成功応答を返します。
- バックグラウンド作業項目プロセッサを開始して、イベント登録と関連エンティティを非同期的に作成します。
キャッシュの動作
読み取りキャッシュ: システムは、イベントとエンティティの検証に 10 分間のキャッシュを適用します。 これにより、Dataverse への冗長読み取りが削減され、負荷の下でのスループットが向上します。
Note
読み取りキャッシュは検証にのみ影響し、登録レコード自体には影響しません。
再試行ロジックとエラー処理
バックグラウンド プロセッサがイベント登録の作成に失敗した場合、システムは最大 6 時間自動的に再試行します。 これは、同期および非同期の障害シナリオに適用され、手動による介入を必要とせずにデータの信頼性を確保します。
スループットとデータバースの制限
フォームレス登録シナリオの主な制限要因は、Dataverse でチケット登録エンティティを作成できる速度です。 通常の条件下では、Dataverse では、ユーザーと Web サーバーごとに、5 分間のスライディング ウィンドウ内で 6,000 個の API 要求の制限が適用されます。 これらの制限を超えると、プラットフォームから 429 Too Many Requests エラーが返される可能性があります。 詳細情報: サービス保護 API の制限。
Important
イベントで支払いゲートウェイが使用されている場合は、追加の検証手順が適用される可能性があり、有効なスループットが低くなる可能性があります。 支払いゲートウェイを使用しているお客様は、特定のセットアップのキャッシュ動作を検証する必要があります。