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

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

 

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

Усі кінцеві точки API вимагають API-ключ, надісланий за допомогою методу аутентифікації Bearer.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://ref.best/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": "\u0412\u0438 \u043d\u0435 \u043c\u0430\u0454\u0442\u0435 \u0434\u043e\u0441\u0442\u0443\u043f\u0443 \u0434\u043e API.",
            "status": 401
        }
    ]
}
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
All API endpoint results work with the UTC timezone unless specified otherwise.
Користувач
Посилання
Статистика посилань
Проекти
Пікселі
Сплеш-сторінки
QR коди
Дані
Notification handlers
Персоналізовані домени
Мої команди
Члени команди
Учасник команди
Журнали облікового запису