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

Дізнайтеся, як підключитися та інтегруватися з нашим API.

Отримати власний ключ API

Базова адреса

Автентифікація

Усі запити до API потребують автентифікації через ключ API, надісланий у заголовку Authorization, як показано нижче.

Authorization: Bearer {api_key}

Приклад

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

Помилки

Наш API використовує стандартні коди статусу HTTP, щоб позначити успіх або невдачу запиту.

Приклад

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

Коди статусу

200 Запит виконано успішно

400 Хибний запит — бракує обов'язкових параметрів або вони некоректні

401 Немає авторизації — ключ API відсутній або недійсний

404 Запитаний ресурс не знайдено

429 Забагато запитів — перевищено ліміт

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

Усі результати ендпойнтів API працюють у часовому поясі UTC, якщо не вказано інше.

Користувач

Посилання

Статистика посилань

Пікселі

Проміжні сторінки

QR-коди

Підписи

Дані

Обробники сповіщень

Власні домени

Команди

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

Участь у командах

Платежі облікового запису

Referred signups

Журнал облікового запису