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

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

Get your own API Key

Базовый URL

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

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

Authorization: Bearer {api_key}

Пример

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

Errors

Our API uses conventional HTTP status codes to indicate the success or failure of a request.

Пример

{
    "errors": [
        {
            "title": "\u0423 \u0432\u0430\u0441 \u043d\u0435\u0442 \u0434\u043e\u0441\u0442\u0443\u043f\u0430 \u043a API.",
            "status": 401
        }
    ]
}

Status codes

200 Request completed successfully

400 Bad request - Required parameters are missing or invalid

401 Unauthorized - API key is missing or invalid

404 The requested resource was not found

429 Too many requests - Rate limit exceeded

500 Internal server error - this means there is a problem on our end

Все результаты конечных точек API работают с **временной зоной UTC**, если не указано иное.

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

Ссылки

Статистика ссылок

Проекты

Пиксели

Заставки

QR-коды

Данные

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

Пользовательские домены

Мои команды

Участники команды

Участник команд

Платежи по аккаунту

Журналы аккаунта