Dokumentacja API

To jest dokumentacja dostępnych punktów końcowych API, które są zbudowane wokół architektury REST. Wszystkie punkty końcowe API zwracają odpowiedź JSON ze standardowymi kodami odpowiedzi HTTP i wymagają uwierzytelniania Bearer za pomocą klucza API.

Get your own API Key

Podstawowy URL

Uwierzytelnianie

Wszystkie punkty końcowe API wymagają klucza API przesłanego metodą Bearer Authentication.

Authorization: Bearer {api_key}

Przykład

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

Errors

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

Przykład

{
    "errors": [
        {
            "title": "Nie masz dost\u0119pu do 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

Wszystkie wyniki punktów końcowych API działają w strefie czasowej UTC, chyba że określono inaczej.

Użytkownik

Linki

Statystyki linków

Projekty

Piksele

Strony powitalne

Kody QR

Dane

Obsługiwacze powiadomień

Domeny niestandardowe

Płatności na konto

Dzienniki konta