---
title: "RESTful APIコレクションサービスのエンドポイント"
slug: "restful-api-endpoints-for-collection-service"
abstract: "Universal Trackerコレクションサービスで利用可能なRESTful APIエンドポイントを説明します。"
---
# RESTful APIコレクションサービスのエンドポイント

このトピックでは、コレクションサービスにアクセスするために使用できるRESTful APIエンドポイントについて説明します。

## 認証

すべてのコレクションサービスエンドポイントは公開されており、認証や承認を必要としません。

## 相互作用

このエンドポイントを使ってコレクションサービスに新しいインタラクションを追加します。各リクエストにはContent-Typeヘッダーが含まれ、値application/json。

動詞

PUT

URL

/interaction

リクエストボディにはJSONオブジェクトが含まれていなければなりません。JSONオブジェクトは [複数のプロパティ](https://doc.sitecore.com/xp/ja/developers/100/sitecore-experience-platform/configuring-the-interaction-requests.html "Configuring the interaction requests")を持つことができます。

成功した操作はステータスコード201(作成済み)を返します。メッセージ本体には作成されたインタラクションIDが含まれています。

エラーは以下のいずれかの回答を示します。

**反応**

**概要**

400

悪いリクエスト。これはサーバーがリクエストを受け入れていないことを示します。パラメータが無効であるためかもしれません。また、リクエストを繰り返すべきでないことも示しています。エラーテキストの本文にはエラーメッセージのテキストが含まれています。

500

内部サーバーエラー。エラーテキストの本文は空の場合もあれば、エラーメッセージの配列を含める場合もあります:\[*Msg1*, *Msg2*\]。

こちらが *インタラクション* リクエストの例です:

PUT https://ut/interaction
Content-Type: application/json
{
 "ChannelId":"27b4e611-a73d-4a95-b20a-811d295bdf77",
 "Initiator":"contact",
 "Contact":{
 "Source":"demosrc",
 "Identifier":"demoident"
 },
 "UserAgent":"Mozilla/5.0(NintendoSwitch;ShareApplet)AppleWebKit/601.6(KHTML,likeGecko)NF/4.0.0.5.9NintendoBrowser/5.1.0.13341.",
 "Events":
 {
 "type":"event",
 "Timestamp":"2019-01-02T11:\`11:11\`.528",
 "DefinitionId":"2DB21B3F-DA14-4AAB-AA6C-C6FCF45FFBF5",
 "EventUniqueId":"ff45c5a2-fb30-4985-99b7-88c725ab3df1"
 }
 
}
## イベント

このエンドポイントを使ってコレクションサービスに新しいイベントを追加します。各リクエストにはContent-Typeヘッダーが含まれ、値application/jsonが必要です。

動詞

PUT

URL

/event

イベントリクエストの本体に含めることができる [イベント](https://doc.sitecore.com/xp/ja/developers/100/sitecore-experience-platform/track-events-operations.html "Track events operations") はいくつかあります。

成功した操作は、メッセージ本文が空の状態でステータスコード201(作成済み)を返します。

エラーは以下のいずれかの回答を示します。

**反応**

**概要**

400

悪いリクエスト。これはサーバーがリクエストを受け入れていないことを示します。おそらくパラメータが無効であるためかもしれません。また、リクエストを繰り返してはいけないことも示しています。エラーテキストの本文にはエラーメッセージの配列が含まれています:\[*Msg1*, *Msg2*\]。

500

内部サーバーエラー。エラーテキストの本文にはエラーメッセージの配列が含まれています:\[*Msg1*, *Msg2*\]。

以下は *イベント* リクエストの例です:

PUT https://ut/event
Content-Type: application/json

 {
 "type":"event",
 "TrackingInteractionId":"d641b469-56a6-4db0-bac1-12979e7f370d",
 "Timestamp":"2018-10-25T14:\`12:01\`.766Z",
 "Duration":"0.\`0:00\`:45.123",
 "DefinitionId":"B826EFFC-D90A-4504-8430-1884F01F7BDF"
 },
 {
 "type":"pageview",
 "TrackingInteractionId":"d641b469-56a6-4db0-bac1-12979e7f370d",
 "Timestamp":"2018-10-26T14:\`13:01\`.766Z",
 "Duration":"0.\`0:00\`:11.124",
 "EventDefinitionId":"9326CB1E-CEC8-48F2-9A3E-91C7DBB2166C",
 "ItemLanguage":"by",
 "ItemVersion":2,
 "ItemId":"EFB92FA2-29A0-4A21-8DB7-5C9251C05AAF",
 "Url":"/",
 "SitecoreRenderingDevice":{"Id":"fe5d7fdf-89c0-4d99-9aa3-b5fbd009c9f3","Name":"Default"}
 },
 {
 "type":"campaign",
 "TrackingInteractionId":"d641b469-56a6-4db0-bac1-12979e7f370d",
 "Timestamp":"2018-10-26T14:\`14:48\`.766Z",
 "EventUniqueId":"ff45c5a2-fb30-4985-99b7-88c725ab3df5",
 "Duration":"0.\`0:00\`:10.124",
 "EventDefinitionId":"F358D040-256F-4FC6-B2A1-739ACA2B2983",
 "CampaignDefinitionId":"110d559f-dea5-42ea-9c1c-8a5df7e70ef9"
 },
 {
 "type":"download",
 "TrackingInteractionId":"d641b469-56a6-4db0-bac1-12979e7f370d",
 "Timestamp":"2018-10-25T08:\`39:48\`.766Z",
 "Duration":"0.\`0:00\`:10.124",
 "EventDefinitionId":"FA72E131-3CFD-481C-8E15-04496E9586DC"
 }

## 完了

このエンドポイントを使ってインタラクションを完了します。

動詞

POST

URL

/interaction/complete

リクエストボディには、完了したいインタラクションのIDが含まれている必要があります。

操作が成功すると、ステータスコード202(Accepted)とメッセージ内容が*true*として返されます。

エラーは以下の回答を示します:

**反応**

**概要**

400

悪いリクエスト。これはサーバーがリクエストを受け入れていないことを示します。おそらくパラメータが無効であるためです。また、リクエストを繰り返してはいけないことも示しています。エラーテキストの本文にはエラーテキストまたはエラーメッセージの配列が含まれています:\[*Msg1*, *Msg2*\]。

以下は *完全な* リクエストの例です:

POST https://ut/interaction/complete
"6914c965-9c27-4777-9110-12c224e2e810"