Endpoints / verify

verify

Auth-Check — bestätigt dass die Credentials gültig sind

Health-Check und Auth-Verifizierung — der einfachste Weg zu prüfen, ob die Zugangsdaten stimmen und das Modul system für den Token freigeschaltet ist. Guter erster Request beim Einrichten einer Integration.

HTTP Request

POST https://dev.vitabyte.ch/v1/system/verify

Auth basicAuth apiKey

Request Parameters

Keine Request-Parameter erforderlich.

Response Parameters

Bei falschen Zugangsdaten antwortet nicht dieser Endpoint, sondern der Handler davor.

Field	Typ	Beschreibung
`status`	boolean	true bei Erfolg, false bei Fehler
`msg`	string	Kurzbeschreibung des Resultats / der Fehlerursache
`result`		Endpoint-spezifisches Resultat. Typ je nach Endpoint (Object, Array, Skalar oder null).
`pagination`		Nur bei Listen-Endpoints gesetzt

Demo

Beispiel-Response handgepflegt — die OpenAPI-Spec liefert für diesen Endpoint noch kein Response-Example.

POST https://dev.vitabyte.ch/v1/system/verify Gültige Zugangsdaten

Payload

[]

Response

{
    "status": true,
    "msg": "Congrats! Looks like you authenticated successfully."
}

POST https://dev.vitabyte.ch/v1/system/verify Zugriff verweigert

Response

{
    "status": false,
    "msg": "Access denied (Basic Auth)"
}