API Reference

Getting Started With Your API

Ця стаття надає покрокові інструкції налаштувань для відправки листів та початку роботи з АРІ-точками.

Якщо Ви використовуєте PHP, то маєте змогу підключити нашу бібліотеку – Sendios SDK.

Перед надсиланням листів необхідно виконати наступні дії:

  1. Налаштувати Домен відправника та Домен для трекінгу

Налаштування Домену для трекінгу є опціональним: використовуйте, якщо вам необхідно відслідковувати відкриття листів та перехід за посиланнями з них.

  1. Встановити SPF / DKIM-записи згідно з налаштуваннями Домену відправника;
  2. Створити Проєкт;
  3. Створити шаблон;
  4. Створити транзакційний лист.

Усі API-точки працюють асинхронно: якщо вам надходить відповідь 200 ОК, то це означає, що ми отримали та взяли в опрацювання ваш запит, і що він пройшов валідацію.

Дізнатися статус відправки листа можна в адмін-панелі – у розділах User profile та Webhooks.

Щоб здійснювати запити на сервер, потрібно авторизуватись. Для цього виконайте наступні кроки:

  1. Дізнайтесь clientId та API key y Customer Success Manager;
  2. Рядок у форматі {clientId}:{api_key} закодуйте в base64;
  3. Отриманий закодований рядок передайте у header авторизації.
ParamsDescription
clientIdІдентифікатор клієнта
api_keyАРІ key
curl -X GET https://api.sendios.io/v1/something-else \
-u {clientId}:{api_key}

Якщо ви використовуєте нашу бібліотеку Sendios SDK, тоді дізнайтеся clientId та SDK key у Customer Success Manager.

🚧

Наразі доступна тільки PHP SDK, iншi мови програмування не підтримуються.

Про статус роботи системи дізнавайтесь із сайту https://status.sendios.io/: тут у випадку інцидентів чи недоступності системи, ми публікуємо актуальну інформацію про проблеми та їх вирішення.

👍

Більше можливостей для моніторингу можна знайти у статті Моніторинг Sendios.

АРІ-точки, які будуть корисні

  • Створення користувачів в базі Sendios відбувається через відповідну АРІ-точку Send system / trigger email при першій відправці будь-якого системного листа (наприклад, тип "Welcome"). Через цю АРІ-точку потрібно передавати інформацію про користувача (електронну адресу і додаткову інформацію: країна, імʼя, мова, стать, вік тощо в масив "user") і змінні для листа (якщо необхідно, в масиві "data").
  • Створити користувача без відправки електронного листа можна за допомогою АРІ-точки Create omnichannel user. При використанні цієї АРІ-точки ви можете одразу додавати будь-які параметри в поле "fields" для передачі інформації про користувача, яка є унікальною для вашого продукту.
  • Для додавання чи оновлення інформації користувача, яка є унікальною для вашого продукту, для вже створеного користувача в системі використовуйте API-точки Add and update user data by project ID and email або Add and update user data by user_id.
  • Для збору аналітики, потрібно передавати деталі оплат на відповідну АРІ-точку Add user payments.
  • Після видалення облікового запису користувача на продукті або відписки зі сторінки налаштувань, необхідно відписати користувача через відповідну АРІ-точку Unsubscribe.
  • За допомогою АРІ-точки Erase user ви можете додати користувача до черги на видалення. Як наслідок, користувач буде видалений через 2 доби. Це окремий функціонал для відповідності GDPR-нормам.