Джерела даних та API

Як підключити джерело даних до власного API

Останнє оновлення

Якщо підключено джерело даних API, Sendtric звертається до вашого API, щоб отримати дані про підписника, коли той відкриває електронний лист. Ніякі дані не копіюються в Sendtric, тому на зображеннях відображається саме те, що повертає ваш API в цей момент, наприклад, поточний статус замовлення або сьогоднішній баланс рахунку.

Якщо ви бажаєте заздалегідь передати дані до Sendtric, див. як надсилати записи за допомогою API Sendtric.

Що потрібно вашому API

  • An HTTPS URL-адреса, доступна з публічного Інтернету.
  • Спосіб запиту одного запису за його ідентифікатором, вказаним у шляху або параметрі запиту. Наприклад https://api.example.com/customers/12345.
  • A JSON відповідь у форматі JSON із полями запису, такими як {"first_name": "Sarah", "points": 1250}.
  • Коротка відповідь: Sendtric чекає до 5 секунд, а розмір відповіді не повинен перевищувати 1 МБ.

Налаштуйте це

  1. У лівій бічній панелі натисніть Джерела даних, а потім Нове джерело даних.
  2. У розділі API, виберіть API та натисніть Продовжити.
  3. Виберіть Отримати дані з API та натисніть Продовжити.
  4. Заповніть Назву джерела даних, Поле унікального ідентифікатора (наприклад customer_id) та, за бажанням, Опис.
  5. Виберіть Метод: GET або POST.
  6. Введіть URL-адресу вашого API та вкажіть {{uid}} ідентифікатор, наприклад https://api.example.com/customers/{{uid}}. Sendtric замінює {{uid}} на ідентифікатор кожного абонента.
  7. Додайте будь-які заголовки , які потрібні вашому API, наприклад Authorization разом із вашим токеном API. Натисніть + Додати для кожного з них.
  8. Додайте будь-які параметри запиту. Якщо ваш API приймає ідентифікатор як параметр, вкажіть {{uid}} його значення замість URL-адреси, наприклад id = {{uid}}.
  9. Введіть дійсний ідентифікатор у Перевірте унікальність ідентифікатора та натисніть Перевірити API.
  10. Перегляньте відповідь, а потім натисніть Зберегти джерело даних.
Налаштування «Отримати дані з API» з URL-адресою, що містить {{uid}}, заголовок «Authorization», тестове значення та успішну тестову відповідь

Зберегти джерело даних залишається неактивним, доки тест не пройде успішно, а відповідь не міститиме принаймні одне поле. Якщо ви зміните URL-адресу, метод, заголовки або параметри, виконайте тест знову.

Використовуйте тестовий кінцевий пункт або спеціальний токен API, призначений лише для читання. Sendtric зберігає значення заголовків у таємниці після збереження, тому для їх зміни вам доведеться ввести їх заново.

Як працює пошук

  • Кожен запит надсилає один запит до вашого API щодо одного передплатника.
  • Ідентифікатори надсилаються саме так, як їх заповнює тег злиття, тому великі та малі літери мають значення, якщо ваш API враховує їх.
  • Sendtric зберігає згенероване зображення протягом час перебування в кеші , який ви встановили в редакторі зображень (від 2 до 60 хвилин), тому при повторному відкритті не відбувається щоразу звернення до вашого API.
  • Якщо ваш API працює повільно, повертає помилку або не містить запису за цим ідентифікатором, значення розглядається як порожнє. У індивідуальному зображенні цей шар приховано, тому створюйте зображення так, щоб воно виглядало правильно й без нього.

Змінити з’єднання

У Джерела данихклацніть на джерелі даних, щоб відкрити його налаштування. Ви можете змінити URL-адресу, метод, заголовки та параметри, а потім запустити Перевірити API ще раз перед збереженням.

Наступний крок

Чи була ця стаття корисною?

Натисніть на зображення, щоб збільшити. Перетягніть або прокрутіть, щоб переглянути.