Навіщо потрібен API
API (Application Programming Interface) — це функціонал для взаємодії між різними програмами. Для людини існують окремі інтерфейси, наприклад сайт. API потрібен для різних інтеграцій. У Sender Solutions є API, який працює за допомогою HTTP-запитів у форматі JSON. Доступ до API надається для всіх тарифних планів проєкту, зокрема й на безкоштовному тарифному плані. Ви можете використовувати API Sender Solutions для більш повної та гнучкої інтеграції. Передбачуваний формат використання API — з вашого сайту на основі тригерів. Наприклад, коли на вашому сайті створюється підписник, сайт виконує API-запит, і підписник з аналогічними даними створюється в Sender Solutions.
Початок використання API
- Щоб використовувати API, вам потрібно створити проєкт в Особистому кабінеті Sender Solutions.
- Далі на сторінці налаштувань проєкту створіть API-ключ. Це унікальний ключ доступу до API на рівні цього проєкту. Зберігайте його в таємниці. Якщо є підозра, що ключ був скомпрометований, якнайшвидше почніть використовувати новий ключ, а скомпрометований ключ деактивуйте або видаліть.
- Для одного проєкту можна створювати кілька API-ключів — усі вони рівноцінні. Це може бути корисно, якщо у вас є кілька різних застосунків, які виконуватимуть API-запити.
- API-ключ необхідно передавати в HTTP-заголовку Authorization.
- Тіло запиту передавайте у форматі JSON, а в заголовку Content-Type вкажіть значення application/json.
- Орієнтуйтеся на HTTP-статус відповіді. Якщо код 200 — усе пройшло успішно. Якщо код 500 — сталася помилка.
- Відповідь від API у загальному випадку повертається у форматі JSON. На кореневому рівні присутній ключ "success" з можливими значеннями true / false.
Приклад успішної відповіді:{
"success": true
}
Приклад відповіді з помилкою:{
"error": "Some error description",
"success": false
}
У тілі успішної відповіді можуть бути додаткові дані залежно від конкретного запиту. - Для роботи з API не потрібна підтримка cookies або сесій.
Корисні ресурси
Composer пакет для роботи з API на php: sender-solutions/php-sdk та цей же пакет на github: Sender-Solutions/php-sdk
Postman колекція запитів до API доступна за посиланням