GET/health

Hälsokontroll

Kontrollera driftstatus för FöretagsAPI-tjänsten.

Översikt

Hälsokontroll-endpointen ger ett enkelt sätt att verifiera att API-tjänsten är i drift. Denna endpoint är användbar för övervakningssystem, lastbalanserare och applikationshälsokontroller.

Ingen autentisering krävs

Hälsokontroll-endpointen kräver ingen autentisering och kan anropas fritt utan API-nyckel eller hastighetsbegränsning.

Gratis endpoint

Denna endpoint är gratis och förbrukar inga krediter. Du kan använda den för övervakning och hälsokontroller utan att påverka din månadskvot.

Förfrågan

HTTP-metod

Denna endpoint använder GET-metod och kräver ingen förfrågningskropp.

Headers

Inga headers krävs för denna endpoint.

Kodexempel

Här är exempel på flera programmeringsspråk:

curl

curl 'https://data.foretagsapi.se/health'

Svar

Lyckat svar (200 OK)

Returnerar ett JSON-objekt som innehåller tjänstens status och tidsstämpel:

json

1
2
3
4
5{
  "status": "ok",
  "service": "foretagsapi-proxy",
  "timestamp": "2024-01-15T10:50:00Z"
}

Svarsfält

Fält	Typ	Beskrivning
status	string	Tjänstens status: "ok" när den är i drift
service	string	Tjänstens namnidentifierare ("foretagsapi-proxy")
timestamp	string	ISO 8601-formaterad tidsstämpel för svaret

Statusvärden

Fältet status indikerar tjänstens tillstånd:

Värde	HTTP-kod	Beskrivning
ok	200	Tjänsten är i drift och redo att ta emot förfrågningar

Tjänsten ej tillgänglig

Om hälsoendpointen inte svarar (timeout eller anslutningsfel) är tjänsten tillfälligt ej tillgänglig. Implementera omförsökslogik i ditt övervakningssystem.

Användningsområden

Lastbalanserare: Konfigurera din lastbalanserare att polla denna endpoint
Övervakningssystem: Integrera med Datadog, New Relic eller Prometheus
Applikationsstart: Verifiera API-tillgänglighet innan förfrågningar behandlas
Statussidor: Visa realtids-API-status på din statussida

Bästa praxis

Vid implementering av hälsokontroller, polla endpointen med jämna intervall (t.ex. var 30:e sekund) och implementera omförsökslogik innan tjänsten markeras som ej tillgänglig.