Orbit API

Orbit API je read-only rozhraní, kterým aplikace Orbit (orbit.codebros.cz) tahá z care přehled o stavu monitoringu webů do svého Work modulu. Je to server-to-server integrace, žádný zásah do spravovaných projektů nevyžaduje.

• Základ URL je https://api.care.codebros.cz.
• Strojově čitelný kontrakt je /openapi.json (OpenAPI 3.1).
• Referenční dokumentace v Markdownu je /docs/orbit-api.md.

Autentizace

Každý požadavek se ověřuje osobním API klíčem v hlavičce:

Authorization: Bearer <apiKey>

• Klíč je per uživatel. Vygeneruješ si ho v care v Nastavení → Integrace → Orbit. Plaintext se zobrazí jen jednou při vytvoření, care ukládá pouze jeho hash.
• Chybějící, neplatný nebo zneplatněný klíč vrací HTTP 401.
• Vrácená data jsou vždy omezená na vlastníka klíče. Admin klíč vidí všechny hlídané weby, klientský klíč jen weby svého klienta.
• Rozhraní je jen pro čtení. Když není co hlásit, vrací prázdná pole nebo null, nikdy ne 404.

Endpointy

Vše je pod GET /api/orbit.

GET /api/orbit/ping

Kontrola dostupnosti a identity.

curl -s https://api.care.codebros.cz/api/orbit/ping \
  -H "Authorization: Bearer $ORBIT_API_KEY"

{
  "ok": true,
  "service": "care",
  "version": "1.0.0"
}

GET /api/orbit/summary

Snímek monitoringu pro přihlášeného uživatele.

curl -s https://api.care.codebros.cz/api/orbit/summary \
  -H "Authorization: Bearer $ORBIT_API_KEY"

{
  "sites": 12,
  "sitesDown": [
    {
      "name": "Acme web",
      "url": "https://acme.cz",
      "since": "2026-07-14T08:03:00Z"
    }
  ],
  "openIncidents": [
    {
      "site": "Acme web",
      "title": "HTTP 500 na homepage",
      "since": "2026-07-14T08:05:00Z"
    }
  ],
  "jobsToday": {
    "done": 4,
    "pending": 1
  },
  "uptime24hPct": 99.8
}

Význam polí:

Jsi AI agent?

Použij strojově čitelný kontrakt z /openapi.json a rozcestník /llms.txt na API doméně. Příklady výše sedí se schématy ve specifikaci.