Зачем нужен API

API (Application Programming Interface) - это функционал для взаимодействия между различными программами. Для человека есть отдельные интерфейсы, такие как сайт. API нужен для различных интеграций. У Sender Solutions есть API, который работает с помощью HTTP запросов в формате JSON. Доступ к API предоставляется для всех тарифных планов проекта, в том числе на бесплатном тарифном плане. Вы можете использовать API Sender Solutions для более полной и гибкой интеграции. Предположительный формат использования API: с вашего сайта, на основе триггеров. Например, когда на вашем сайте создаётся подписчик, ваш сайт делает API запрос, и подписчик с аналогичными данными создаётся на Sender Solutions.

Начало использования API

1. Чтобы использовать API, вам нужно создать Проект в Личном кабинете Sender Solutions
2. Далее, на странице Настроек проекта, создайте API ключ. Это уникальный ключ доступа к API на уровне этого проекта. Храните его в секрете. Если есть подозрения, что ключ был скомпрометирован, начните использовать новый ключ как можно скорее, а скомпрометированный ключ деактивируйте или удалите
3. Для одного проекта можно создавать несколько API ключей, все они равноценны. Это может быть полезно, если у вас есть несколько различных приложений, которые будут делать API запросы
4. API ключ нужно передавать в HTTP заголовке Authorization
5. Тело запроса передавайте в JSON, в заголовке Content-Type укажите значение application/json
6. Ориентируйтесь на HTTP статус код ответа. Если код 200 - всё хорошо. Если код 500 - произошла ошибка
7. Ответ от API, в общем случае, будет в формате JSON. На корневом уровне будет ключ "success": с возможными значениями true / false
   Пример успешного ответа:
   {
    "success": true
}
   
   Пример ответа с ошибкой:
   {
    "error": "Some error description",
    "success": false
}
   В теле успешного ответа могут быть дополнительные данные в зависимости от конкретного запроса.
8. Для работы с API не требуется поддержка cookies или сессии

Полезные ресурсы

Скоро тут добавятся ссылки на полезные инструменты для работы с API, в частности, Postman коллекция запросов и composer пакет работы с API на PHP. Проверьте через недельку.