最初のAPI呼び出し

Auxiaで最初のAPI呼び出しを行う方法

ステップ1: サンプルトリートメントを作成する

こちらのガイド(最初のトリートメントの作成)にアクセスして、テスト用のサンプルトリートメントを設定してください。

ステップ2: リクエストを送信する

コンソールに移動し、API Integration タブをクリックして、「Show API Key」をクリックしてAPIキーを取得します。

api-integration

APIキーを取得したら、以下のcurlリクエストをUIまたはターミナルから実行してください。

curl --location --request POST 'https://apis.auxia.io/v1/GetTreatments' \
--header 'Content-Type: application/json' \
--header 'x-api-key: *********************' \
--data-raw '{
    "projectId": "1802",
    "userId": "gGTE8CWUIgpzPivCejVk7JN284V",
    "surfaces": [
        {
            "surface": "HOME_PAGE",
            "maximumTreatmentCount": 1
        }
    ]
}'

リクエストの内容

{
    "projectId": "1802",
    "userId": "gGTE8CWUIgpzPivCejVk7JN284V",
    "surfaces": [
        {
            "surface": "HOME_PAGE",
            "maximumTreatmentCount": 1
        }
    ]
}

このリクエストには以下のパラメータがあります:

Param	Type	Description
projectId	string	特定のお客様のプロジェクトに対して、常に同じ値を使用します。
userId	string	各ユーザーの一意のIDです。
surfaces	string	surface JSONを参照してください。

Surface

Param	Type	Description
surface	string	特定のUIコンポーネント、画面（ホーム画面）、またはユースケース（クーポン）に対してトリートメントをリクエストするためのクライアント設定パラメータです。surfaceの典型的な例としては「HOME_SCREEN」や「PURCHASE_SCREEN」があります。
maximumTreatmentCount	int64	指定されたsurfaceに対してクライアントに返されるトリートメントの最大数です。値が設定されていない場合、デフォルトは1です。
minimumTreatmentCount	int64	指定されたsurfaceに対してクライアントに返されるトリートメントの最小数です。このフィールドが設定されている場合、レスポンスには0個、またはminimumTreatmentCount以上のトリートメントが含まれることが保証されます。値が設定されていない場合、デフォルトは0です。

以下はサンプルレスポンスです:

{
   "responseId": "690e24d8-16a6-4518-bf37-09a8f0120dfb",
   "userTreatments": [
       {
           "treatmentId": "6",
           "treatmentTrackingId": "6_690e24d8-16a6-4518-bf37-09a8f0120dfb",
           "rank": "1",
           "treatmentContent": "{ title: 'You have a new message!', description: 'Learn how our product helps you', cta_name: 'Learn more', cta_link: '/tabs/home/feed'}",
           "treatmentType": "IN_APP_CONTENT_CARD",
           "surface": "HOME_PAGE",
           "contentLanguageCode": "en",
       },
       {
           "treatmentId": "4",
           "treatmentTrackingId": "4_690e24d8-16a6-4518-bf37-09a8f0120dfb",
           "rank": "2",
           "treatmentContent": "{ title: 'Check out your trends', description: '87% of users found this feature useful', cta_name: 'View trends', cta_link: '/actionscreen'}",
           "treatmentType": "IN_APP_CONTENT_CARD",
           "surface": "HOME_PAGE",
           "contentLanguageCode": "en",
       }
   ]
}

ステップ1: サンプルトリートメントを作成する​

ステップ2: リクエストを送信する​

ステップ1: サンプルトリートメントを作成する

ステップ2: リクエストを送信する