API Documentation

Как подключиться к API и встроить его в свой проект.

Base URL

Authentication

All the API endpoints require an API key sent by the Bearer Authentication method.

Authorization: Bearer {api_key}

Example

curl --request GET \
--url 'https://popup.bz/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

API использует обычные HTTP-коды: по ним видно, прошёл запрос или нет.

Example

{
    "errors": [
        {
            "title": "You do not have access to the API.",
            "status": 401
        }
    ]
}

Коды ответа

200 Запрос выполнен

400 Неверный запрос — не хватает параметров или они некорректны

401 Нет доступа — API-ключ не передан или неверен

404 Запрошенный ресурс не найден

429 Слишком много запросов — превышен лимит

500 Внутренняя ошибка сервера — проблема на нашей стороне

Все результаты API-эндпоинтов работают с UTC временной зоной, если не указано иное.

Пользователь

Статистика

Сайты

Виджеты сайта

Обработчики уведомлений

Мои команды

Члены команды

Член команды

Платежи

Реферальные регистрации

Логи аккаунта