Як надсилати записи до джерела даних за допомогою API Sendtric
Останнє оновлення
За допомогою джерела даних API ваша система надсилає записи у форматі JSON до Sendtric щоразу, коли ваші дані змінюються. Sendtric зберігає їх як хостовані дані, і ваші зображення отримують доступ до запису кожного підписника під час відкриття електронного листа.
Цей посібник призначений для тих, хто пише код, що відправляє дані. Якщо ви бажаєте, щоб Sendtric отримував дані з вашого API при кожному відкритті, див. як підключити джерело даних до вашого власного API.
Створити джерело даних
- У лівій бічній панелі натисніть Джерела даних, а потім Нове джерело даних.
- У розділі API, виберіть API та натисніть Продовжити.
- Виберіть Надіслати дані до Sendtric та натисніть Продовжити.
- Вкажіть:
- Назва джерела даних: наприклад, «Учасники програми лояльності».
- Поле унікального ідентифікатора: поле JSON, яке ідентифікує кожен запис, наприклад
customer_idабоemail. Кожен запис, який ви надсилаєте, повинен містити це поле. - Опис (не обов'язково).
- Натисніть Зберегти джерело даних. Джерело даних створено, і На цьому відображає ваші кінцеві точки та ключ API.
- Скопіюйте те, що вам потрібно, а потім натисніть Продовжити , щоб завершити.

Ви можете знову знайти кінцеві точки в будь-який час у розділі Джерел даних вкладці «Деталі API» .
Увійти
Надішліть свій ключ у Authorization заголовку кожного запиту:
Authorization: Bearer YOUR_API_KEY
Content-Type: application/jsonThe Ключ API джерела даних працює лише для надсилання записів джерела даних, тому його можна безпечно надати розробнику або інструменту автоматизації. Якщо ви користуєтеся тарифним планом API, ваш існуючий ключ API також працює з цими кінцевими точками.
Не розміщуйте свій ключ у коді інтерфейсу та у загальнодоступних репозиторіях. Якщо він коли-небудь стане відомим, перегенеруйте його за адресою Налаштування → API-ключі → API-ключ джерела даних, а потім оновіть усі елементи, які його використовують.
Створити або оновити записи
Надішліть один об’єкт JSON або масив об’єктів на кінцеву точку, вказану в Sendtric. Один запис:
POST <your data source endpoint>
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"customer_id": "CUST_1001",
"first_name": "Sarah",
"points": 1250
}Кілька записів в одному запиті:
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 }
]Як зберігаються записи:
- Якщо запису з таким ідентифікатором ще немає, створюється новий.
- Якщо хтось це робить, то це замінюється на те, що ви надіслали. Поля, які ви пропускаєте, видаляються, тому завжди надсилайте повний запис.
- Нові та оновлені записи зазвичай стають доступними приблизно за хвилину.
- Ідентифікатори зіставляються без урахування регістру.
У разі успішного виконання запиту повертається 200 короткий виклад, наприклад {"status":"ok","records":2}.
Ви можете вкладати об’єкти всередину запису, наприклад "address": { "city": "Leeds" }, і вибирати вкладені поля в редакторі зображень.
Видалити записи
Щоб видалити один запис, додайте його ідентифікатор у кінець адреси кінцевої точки:
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"]Обмеження
| Обмеження | Значення |
|---|---|
| Кількість записів на один запит | 10 000 |
| Розмір запиту | 10 МБ |
| Значення ідентифікатора | 255 символів |
| Будь-яке окреме текстове значення | 10 КБ |
| Глибина вкладання | 20 рівнів |
Надсилайте записи партіями, а не окремим запитом для кожного запису. Якщо йдеться про тисячі записів, див. як надсилати великі обсяги даних до джерела даних.
Відповіді та помилки
| Статус | Що це означає | Що робити |
|---|---|---|
| 200 | Записи прийнято | Нічого. Якщо деякі записи було пропущено, у заголовку X-Skipped-Records вказано, скільки саме |
| 400 | Дані не відповідають формату JSON | Перевірте тіло запиту |
| 401 | Відсутній або неправильний ключ API | Перевірте заголовок «Authorization» |
| 404 | Не вдалося знайти джерело даних для цього ключа | Перевірте кінцеву точку та переконайтеся, що ключ належить тому самому обліковому запису |
| 413 | Занадто багато записів або занадто великий розмір | Розділіть запит на менші партії |
| 422 | Не вдалося зберегти запис | У повідомленні вказано, у яких записах відсутнє поле ідентифікатора або які записи мають занадто великий розмір |
| 503 | Sendtric зараз зайнятий | Зачекайте кількість секунд, вказану в заголовку Retry-After, а потім надішліть той самий запит ще раз |
Якщо лише деякі записи у запиті є недійсними, дійсні записи все одно зберігаються, а решту пропускають.
Перевірте свої записи
Відкрийте джерело даних і перейдіть до вкладку «Записи» . Здійсніть пошук за значенням ідентифікатора та натисніть на запис, щоб переглянути повний JSON-файл, збережений у Sendtric.
Наступний крок
- Як використовувати джерело даних у індивідуальному зображенні
- Як використовувати джерело даних у зображенні на основі правил
- Як керувати джерелом даних, редагувати його та видаляти
Чи була ця стаття корисною?
Дякуємо за відгук!
