Kort svar
Slå API og integrationer til, og lad udvikleren prøve af med en testnøgle. Opret så en API-nøgle med kun de rettigheder, systemet skal bruge, og evt. en webhook. Hold øje med adgangsloggen bagefter.
Før du starter
- Du skal være i Bestyrelse.
- Find ud af, hvem der bygger eller sætter integrationen op, og hvilke data systemet skal læse eller skrive. En infoskærm skal fx kun læse.
Sådan gør du
Før
- Gå til Foreningen → Moduler, og slå API og integrationer til. Se Sådan slår du et modul til eller fra.
- Skal Vicevært stå for integrationen, så giv adgang. Se Sådan giver du viceværten lov til at administrere integrationer.
Afprøvning
- Giv udvikleren en testnøgle til sandkassen, hvis jeres plan har den. Så kan de bygge og teste uden at røre jeres rigtige data. Se Sådan giver du en udvikler en testnøgle.
- Henvis udvikleren til docs.naboportalen.dk.
Den rigtige nøgle
- Opret en API-nøgle med et konkret navn, fx “Infoskærm i opgang 3”. Vælg kun de rettigheder, systemet skal bruge. Begræns evt. nøglen til systemets IP-adresser. Se Sådan opretter du en API-nøgle.
- Kopiér nøglen, og giv den til udvikleren på en sikker måde. Den vises kun én gang.
Besked, når der sker noget
- Skal systemet have besked med det samme, fx når en sag oprettes, så opret en webhook. Se Sådan opretter du en webhook.
Bagefter
- Se i adgangsloggen, at kaldene går igennem. Står der mange afviste kald, mangler nøglen måske en rettighed. Se Sådan ser du, hvad en integration har gjort.
- Rotér nøglen, før den udløber. Bestyrelse og dem, der har fået integrationsadgang, får besked 30 og 7 dage før.
Hvis …
- … systemet ikke skal bruges mere: Tilbagekald nøglen, og slet webhooken.
- … der kommer en ny Bestyrelse: Gennemgå listen over nøgler og hvem, der har integrationsadgang. Rotér de nøgler, som afgåede medlemmer har haft fat i.
- … nøglen er kommet i forkerte hænder: Tilbagekald den med det samme. Den holder op med at virke straks.
Godt at vide
- Systemet kan kun det, I har sat flueben ved. Vælger I rettigheder med personoplysninger, står det tydeligt, når I opretter nøglen.
- Det er jer, der bestemmer, hvilke data der sendes videre. Aftal med den, der får data, hvad de må bruge dem til.
- Alt, hvad nøglen gør, står i adgangsloggen i 13 måneder.
