Определение
REST API — это веб-интерфейс, который предоставляет ресурсы, например сообщения, контакты или шаблоны, по определённым URL и позволяет программам создавать, читать, обновлять и удалять их с помощью стандартных HTTP-методов (POST, GET, PATCH, DELETE), как правило, в формате JSON.
REST (representational state transfer) — это архитектурный стиль, описанный Роем Филдингом в 2000 году. На практике REST API для сообщений означает отправку аутентифицированного HTTPS-запроса, например POST /messages с телом в формате JSON, и получение JSON-ответа с идентификатором и статусом. Результат обозначают коды статуса HTTP: 2xx — успех, 4xx — ошибки клиента, например неверные номера или отсутствие авторизации, 5xx — ошибки сервера.
Типичные приёмы: аутентификация по bearer-токену в заголовке Authorization, ключи идемпотентности, чтобы повторные запросы не создавали дубликаты, постраничная выдача для списков, лимиты запросов с заголовками retry-after и вебхуки для асинхронных результатов, например отчётов о доставке (DLR).
REST подходит для большинства интеграций: CRM, платформ электронной коммерции и внутренних систем. Для очень больших объёмов SMS операторы и агрегаторы часто используют SMPP, который поддерживает постоянное соединение.
Спецификация OpenAPI описывает эндпоинты в машиночитаемом виде, поэтому по ней можно генерировать клиентские SDK, документацию и тесты.
OmniChannels.ai предоставляет REST/JSON API по адресу https://api.broadnet.me с аутентификацией по bearer-токену, спецификацией OpenAPI 3.1 и TypeScript SDK.
Пример
POST https://api.broadnet.me/… с заголовком "Authorization: Bearer <token>" и телом в формате JSON; в ответе возвращается идентификатор сообщения.