データソースとAPI

Sendtric API を使用してデータソースにレコードを送信する方法

最終更新日

APIデータソースを使用すると、データに変更があった際に、お客様のシステムからSendtricへJSONレコードが送信されます。Sendtricはそれらをホスト型データとして保存し、メールが開かれた際に、各購読者のレコードを参照します。

このガイドは、データを送信するコードを作成される方に向けたものです。代わりに、Sendtricがメールが開かれるたびにAPIからデータを取得するようにしたい場合は、データソースを独自のAPIに接続する方法.

データソースを作成します

  1. 左側のサイドバーで、[データソース]をクリックし、次に[新しいデータソース].
  2. 「以下」APIで、APIを選択し、「続行」をクリックしてください.
  3. 選択してください「Sendtricにデータを送信」を選択しを選択し、「続行」をクリックしてください.
  4. 以下に記入してください:
    • データソース名:例:「ロイヤリティ会員」。
    • 一意の識別子フィールド: 各レコードを識別するJSONフィールドです。例えば、customer_idまたはemailなど。送信するすべてのレコードに、このフィールドを含める必要があります。
    • 説明(任意)。
  5. クリック[データソースを保存]をクリックします。データソースが作成され、APIステップに、エンドポイントとAPIキーが表示されます。
  6. 必要な部分をコピーしてから、「続行」をクリックして完了してください。
新しいデータソースのAPIステップでは、単一レコードおよび一括のアップサート用エンドポイント、APIキー、およびリクエスト例が示されています。

エンドポイントは、データソースの「APIの詳細」タブから再度確認できます。

認証する

すべてのリクエストのAuthorization各リクエストのヘッダーにキーを送信してください:

Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

TheデータソースAPIキーはは、データソースレコードの送信にのみ使用されるため、開発者や自動化ツールに提供しても問題ありません。APIプランをご利用の場合は、既存のAPIプランキーもこれらのエンドポイントでご利用いただけます。

鍵はフロントエンドのコードや公開リポジトリには含めないでください。万が一漏洩した場合は、設定→ APIキー→データソース API キーから再生成し、そのキーを使用しているすべての箇所を更新してください。

レコードの作成または更新

Sendtricに表示されているエンドポイントに、単一のJSONオブジェクト、またはオブジェクトの配列をPOSTしてください。1件のレコード:

POST <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

{
  "customer_id": "CUST_1001",
  "first_name": "Sarah",
  "points": 1250
}

1回のリクエストで複数のレコードを処理する場合:

POST <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

[
  { "customer_id": "CUST_1001", "first_name": "Sarah", "points": 1250 },
  { "customer_id": "CUST_1002", "first_name": "James", "points": 300 }
]

レコードの保存方法:

  • その識別子を持つレコードがまだ存在しない場合は、新しいレコードが作成されます。
  • もしそうするなら、それは送信された内容と送信された内容に置き換えられます。記載されていない項目は削除されますので、必ず完全なレコードを送信してください。
  • 新規および更新された記録は、通常、約1分以内に利用可能になります。
  • 識別子の照合は、大文字と小文字を区別せずに 行われます。

リクエストが成功すると、200簡単な概要を返します。例えば、{"status":"ok","records":2}.

レコード内にオブジェクトをネストさせることができます。例えば"address": { "city": "Leeds" }、画像エディタでネストされたフィールドを選択することができます。

レコードを削除する

エンドポイントの末尾に識別子を追加することで、1件のレコードを削除します:

DELETE <your data source endpoint>/cust_1001
Authorization: Bearer YOUR_API_KEY

識別子の配列を送信して、複数を削除します:

DELETE <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json

["cust_1001", "cust_1002"]

制限

上限値
1回のリクエストあたりのレコード数10,000
リクエストサイズ10 MB
識別子の値255文字
任意の単一のテキスト値10 KB
ネストの深さ20ステージ

レコードごとに1回ずつリクエストを送信するのではなく、レコードをまとめて送信してください。数千件のレコードについては、データソースへ大量のデータを送信する方法.

応答とエラー

ステータスその意味どうすればよいでしょうか
200記録の受理特にありません。一部のレコードがスキップされた場合、X-Skipped-Records ヘッダーにその数が記載されています。
400本文は有効なJSONではありませんリクエスト本文を確認してください
401APIキーが欠落しているか、間違っていますAuthorizationヘッダーを確認してください
404このキーに対応するデータソースが見つかりませんでしたエンドポイントを確認し、そのキーが同じアカウントに属していることを確認してください
413レコードの数が多すぎるか、サイズが大きすぎるリクエストをより小さなバッチに分割します
422レコードを保存できませんでしたこのメッセージには、識別子フィールドが欠落しているレコードや、サイズが大きすぎるレコードが一覧表示されています
503Sendtricは現在、多忙を極めています「Retry-After」ヘッダーに指定された秒数待ってから、同じリクエストを再度送信してください

リクエストに含まれるレコードの一部のみが無効な場合、有効なレコードは保存され、残りのレコードはスキップされます。

記録をご確認ください

データソースを開き、「レコード」タブに移動してください。識別子の値で検索し、レコードをクリックすると、Sendtricに保存されているJSONの全内容を確認できます。

次のステップ

この記事は役に立ちましたか?

画像をクリックすると拡大します。ドラッグまたはスクロールで移動できます。