Документация API

Это документация по доступным конечным точкам API, построенным на REST архитектуре. Все конечные точки API возвращают JSON ответ со стандартными HTTP кодами ответов и требуют Bearer аутентификацию с помощью API ключа.

 

Аутентификация

Все конечные точки API требуют API ключ, отправляемый методом Bearer аутентификации.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://pusher.uveb.ru/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Ошибки

API использует обычные коды HTTP, чтобы показать, удался запрос или нет.

{
    "errors": [
        {
            "title": "\u0423 \u0432\u0430\u0441 \u043d\u0435\u0442 \u0434\u043e\u0441\u0442\u0443\u043f\u0430 \u043a API.",
            "status": 401
        }
    ]
}
200 Запрос выполнен
400 Неверный запрос: нет обязательных параметров или они неверны
401 Нет доступа: ключ API отсутствует или неверен
404 Такого ресурса нет
429 Слишком много запросов: лимит исчерпан
500 Ошибка сервера: проблема на нашей стороне
Ответы API считаются в часовом поясе UTC, если не указано иное.
Пользователь
Веб-сайты
Подписчики
Статистика подписчиков
Логи подписок
Рассылки
Личные уведомления
RSS автоматизации
Повторяющиеся рассылки
Цепочки
Сегменты
pwas.title
Уведомления
domains.title
Мои команды
Члены команды
Член команды
referrals_users.title
Журналы аккаунта