Kort svar

Gå til Foreningen → Integrationer, og tryk Opret API-nøgle. Giv nøglen et navn, sæt flueben ved det, systemet må, og tryk Opret nøgle. Kopiér nøglen med det samme. Den vises kun én gang.

Før du starter

Sådan gør du

  1. Gå til Foreningen, og tryk Integrationer.
  2. Tryk Opret API-nøgle. Er der ingen nøgler endnu, hedder knappen Opret den første nøgle.
  3. Under Hvad bruges nøglen til? skriver du et konkret navn, fx “Infoskærm i opgang 3”. Tryk Næste.
  4. Sæt flueben ved de rettigheder, systemet skal have. Intet er valgt på forhånd. Med Vælg alle læse-scopes vælger du alle læserettigheder i en gruppe. Tryk Næste.
  5. Skriv evt. de adresser, nøglen må bruges fra, i IP-adresser der må bruge nøglen (valgfrit). Skriv én pr. linje.
  6. Vælg en dato under Udløber.
  7. Tjek Opsummering, og tryk Opret nøgle.
  8. Siden Nøglen er oprettet åbner. Tryk Kopiér, og giv nøglen til den, der bygger integrationen, på en sikker måde.
  9. Tryk Jeg har gemt nøglen.

Hvis …

  • … systemet skal have flere eller færre rettigheder: Tryk på blyanten ud for nøglen. Ret fluebenene eller IP-adresserne, og tryk Gem ændringer. Ændringen virker med det samme.
  • … nøglen er mistet eller skal skiftes: Tryk på pilene ud for nøglen, og bekræft med Rotér nøgle. Den nye nøgle vises én gang. Den gamle virker i 24 timer endnu, så systemet kan nå at skifte. Imens står der Roteres (den gamle virker 24 timer) ved den gamle nøgle.
  • … systemet ikke skal have adgang mere: Tryk på skraldespanden ud for nøglen, og bekræft med Tilbagekald. Nøglen holder op med at virke med det samme. Det kan ikke fortrydes.
  • … knappen Opret API-nøgle mangler: Så står der “Foreningens plan tillader ikke flere aktive API-nøgler.” Tilbagekald en nøgle, I ikke bruger, eller skriv til NaboPortalen.
  • … en rettighed er grå: Der står Kræver plan ved den. Den kan ikke vælges med jeres plan.

Godt at vide

  • Nøglen kan altid læse foreningens navn og grundoplysninger (tenant:read). Det står som Altid tildelt.
  • Rettigheder arver ikke hinanden. Må systemet oprette sager, må det ikke dermed læse dem. Vælg begge, hvis det skal.
  • Vælger du rettigheder med personoplysninger, står der Nøglen får adgang til personoplysninger med en liste over dem.
  • Navnet på nøglen står i adgangsloggen og i aktivitetsloggen. Skriv det, så den næste Bestyrelse kan forstå, hvad nøglen bruges til.
  • Står der IP ved nøglen, virker den kun fra de adresser, du har skrevet.
  • En nøgle udløber som standard efter 12 måneder og højst efter 24. Bestyrelse og dem, der har fået integrationsadgang, får besked 30 og 7 dage før. Står der Udløber snart — rotér i tide, så rotér den.
  • NaboPortalen gemmer ikke selve nøglen. Derfor kan den ikke vises igen.
  • Dokumentationen til udvikleren ligger på docs.naboportalen.dk. Adressen til jeres forenings API står nederst på siden Integrationer.
  • Alt, hvad nøglen gør, kan du se i adgangsloggen.