API-Dokumentation

Erfahren Sie, wie Sie sich mit unserer API verbinden und sie integrieren können.

Basis-URL

Authentifizierung

Alle API-Endpunkte erfordern einen API-Schlüssel, der über die Bearer-Authentifizierungsmethode gesendet wird.

Authorization: Bearer {api_key}

Beispiel

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

Unsere API verwendet die üblichen HTTP-Statuscodes, um Erfolg oder Fehler einer Anfrage anzuzeigen.

Beispiel

{
    "errors": [
        {
            "title": "Sie haben keinen Zugriff auf die API.",
            "status": 401
        }
    ]
}

Statuscodes

200 Anfrage erfolgreich abgeschlossen

400 Ungültige Anfrage - Erforderliche Parameter fehlen oder sind ungültig

401 Nicht autorisiert - API-Schlüssel fehlt oder ist ungültig

404 Die angeforderte Ressource wurde nicht gefunden

429 Zu viele Anfragen - Rate-Limit überschritten

500 Interner Serverfehler - dies bedeutet, dass auf unserer Seite ein Problem vorliegt

Alle API-Endpunkt-Ergebnisse arbeiten mit der Zeitzone UTC, sofern nicht anders angegeben.

Benutzer

Websites

Audits

Archivierte Audits

Benachrichtigungs-Handler

Benutzerdefinierte Domains

Kontoprotokolle