Verfügbarkeit

Die Verfügbarkeitsprüfung sagt Monitoren, ob die API läuft. Sie braucht kein Token und trägt bewusst kein Versions-Präfix.

Jeder Endpunkt unten zeigt in der Mitte seine Parameter und Antwortfelder und rechts ein Anfragebeispiel mit Beispielantwort.

Basis-URL https://api.sally.ioVersion v1.0 aktuell, noch nicht eingefrorenSo funktioniert die Versionierung

Verfügbarkeitsprüfung der Public API

GET/healthOhne Authentifizierung

Schlanke Verfügbarkeits- bzw. Health-Prüfung für Monitoring und Uptime-Checks (z. B. ein Load Balancer oder eine Statusseite). Erfordert KEINE Authentifizierung (keinen Bearer-Token) und liest weder Mandantendaten noch die Datenbank. Der Endpunkt bestätigt nur, dass der API-Prozess läuft und antwortet, und meldet, welcher Service, welche Umgebung und welche Version geantwortet hat.

Feldübersicht aus der Spezifikation

Felder der Antwort:

• status (string): Integritätsstatus; immer ok, wenn der Service antwortet.
• service (string): Name des Service, der geantwortet hat.
• environment (string): Umgebung, in der der Service läuft (z. B. dev, prod).
• version (string): Version des laufenden Service.
• timestamp (string): Zeitpunkt, zu dem die Antwort erzeugt wurde (UTC ISO-8601).

Mögliche Ergebnisse:

• 200: Der Service läuft (Body wie oben). Dieser Endpunkt selbst liefert immer nur 200, wenn er erreicht wird.
• keine Antwort / 502 / 503 / 504: wird vom Gateway bzw. der Infrastruktur zurückgegeben, NICHT von diesem Endpunkt, wenn der Service ausgefallen ist, noch startet oder nicht erreichbar ist. Eine fehlende Antwort oder eine Antwort außerhalb von 2xx ist genau das „unhealthy"-Signal, auf das eine Verfügbarkeitsprüfung achtet.

Antwort

• statusstringPflicht

  Integritätsstatus des Service; ok, wenn er läuft.

  Beispiel: ok
• servicestringPflicht

  Name des Service, der geantwortet hat.

• environmentstringPflicht

  Umgebung, in der der Service läuft (z. B. dev, prod).

• versionstringPflicht

  Version des laufenden Service.

• timestampstringPflicht

  Zeitpunkt, zu dem die Antwort erzeugt wurde (UTC ISO-8601).

Statuscodes

• 200Der Service läuft.

Anfrage

cURL

curl "https://api.sally.io/health"

JavaScript

const response = await fetch(`https://api.sally.io/health`);
const data = await response.json();

Python

import requests

response = requests.get(
    f"https://api.sally.io/health",
)
data = response.json()

Beispielantwort 200 OK

{
  "status": "ok",
  "service": "string",
  "environment": "string",
  "version": "string",
  "timestamp": "string"
}