Spring til indhold
Regsta

Har Regsta et API og webhooks?

Skrevet til
  • Administrator

Kort svar

Ja. Regsta har et skrivebeskyttet REST-API, version 1, til medarbejdere, vagter og den udgivne vagtplan, og webhooks, der giver jeres egne systemer besked, når noget sker. En administrator opretter API-nøgler og webhook-endpoints under Sikkerhed. API'et kan ikke oprette eller ændre data.

API'et

  • Skrivebeskyttet: version 1-endpoints besvarer GET-forespørgsler om medarbejdere, vagter og udgivet vagtplan.
  • Kontrakten er publiceret som OpenAPI 3.1 på /api/v1/openapi, så I kan generere eller validere en klient ud fra den.
  • Send en API-nøgle i Authorization-headeren (Bearer). En nøgle hører til én virksomhed og kan kun læse det, dens scopes tillader.
  • Fejl har en stabil kode og et request-id, som I kan give os.
  • Lange lister hentes side for side med en cursor.

API-nøgler

Åbn Sikkerhed i Regsta, og gå til API-adgang. Vælg Opret API-nøgle, giv den et navn, og vælg, hvad nøglen kan læse. Nøglen vises én gang. Regsta gemmer kun en SHA-256-hash af den, så en mistet nøgle kan ikke vises igen: tilbagekald den, og opret en ny.

Webhooks

Under Sikkerhed i Webhooks tilføjer en administrator et endpoint: en offentlig HTTPS-adresse og de hændelser, der skal sendes. Regsta viser signeringshemmeligheden én gang og gemmer den krypteret.

  • Hver levering signeres med HMAC-SHA256 over tidsstempel og indhold. Kontrollér signaturen, og afvis gamle tidsstempler for at stoppe genafspilning.
  • En levering, der fejler, forsøges igen med stigende pauser. Efter gentagne fejl flyttes den til en dead-letter-kø og forsøges ikke igen.
  • I kan se leveringsstatus for hvert endpoint.

Hændelser, der sendes i dag

  • employee.created
  • employee.updated
  • schedule.published
  • payroll_period.closed
  • payroll_period.reopened
  • export.generated
API'et læser; det skriver ikke. Der er ingen endpoints til at oprette medarbejdere, udgive en vagtplan eller godkende tid, og webhooks sendes kun for de seks hændelser ovenfor.

Fik du ikke svar på dit spørgsmål?

Skriv, hvad du ledte efter, så svarer vi.

Kontakt os