Зачем нужен 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 доступна по ссылке