Med en API-nyckel kan ett annat system, ett skript eller en AI-assistent läsa och arbeta med föreningens data i Styrelseproffset. Nyckeln agerar i ditt namn. Den kan aldrig göra mer än du själv får, och du kan begränsa den till bara det den behöver.
Vill du använda Claude eller ChatGPT behöver du ingen nyckel. Du ansluter tjänsten direkt och loggar in som vanligt.
Skapa en nyckel
Klicka på Lägg till, ge nyckeln ett namn som säger vad den används till och spara. Själva nyckeln visas en enda gång, direkt efter att du sparat. Kopiera den då. Vi sparar den bara i en form som inte går att läsa tillbaka, så har du tappat bort den får du generera en ny.
En ny nyckel slutar gälla efter ett år. Ändra datumet under Löper ut om den ska gälla kortare eller längre tid, eller töm fältet om den aldrig ska gå ut.
Begränsa vad nyckeln får göra
Under Behörighet väljer du vad nyckeln får göra. Varje nivå omfattar nivåerna före den:
- Enbart läsa
- Läsa, skapa och ändra. Det här är förvalt för en ny nyckel.
- Läsa, skapa, ändra och ta bort
- Allt, även skicka, publicera och signera
Under Komponenter väljer du vilka delar av föreningen nyckeln kommer åt, till exempel bara möten och kalendern.
Skicka, publicera och signera omfattar allt som lämnar föreningen eller inte går att ångra. Det gäller utskick, sms och notiser till andra, signeringar och omröstningar, att tilldela någon ett ärende, ändringar på den publicerade hemsidan och export av hela listor eller mappar. Ge inte den nivån till en AI-assistent. En assistent läser text som andra har skrivit, till exempel inkommande mejl, och kan luras att göra något du inte bett om. Formuläret varnar när du väljer en nivå som kan ta bort eller agera utåt.
En begränsad nyckel kommer inte åt chatten eller AI-assistenten, och den kan aldrig ändra personnummer, e-postadresser eller mobilnummer på medlemmar, hyresgäster, leverantörers kontaktpersoner och signerare. Den kan inte heller ta bort något permanent. Det som går att lägga i papperskorgen hamnar där.
Se vad en nyckel har gjort
Allt som görs med en nyckel syns i aktivitetsloggen med nyckelns namn, till exempel "skapade aktivitetslistan Vårstädning · via API-token Min assistent". Listan över nycklar visar när varje nyckel senast användes.
Varje anrop som görs med föreningens nycklar finns också i API-loggen, som du når med knappen överst på sidan med API-nycklar. Välj Logg på en nyckel för att se bara den. Loggen visar när anropet gjordes, vad som efterfrågades, om det godtogs och från vilken IP-adress. Den visar aldrig vad som svarades. Där syns också försök med en nyckel som inte godtogs, till exempel en nyckel som har gått ut eller tagits bort. Loggen sparas i 90 dagar.
Ser du anrop du inte känner igen, eller från en adress du inte väntar dig, ta bort nyckeln och skapa en ny.
Ta bort en nyckel som inte längre behövs. Den slutar då fungera direkt. En nyckel slutar också fungera om användaren den tillhör tas bort ur föreningen.
Teknisk dokumentation
Hur API:et används beskrivs i API-dokumentationen. En nyckel som försöker göra något den inte har behörighet till får svaret 403 med koden scope_denied. Den som gör väldigt många anrop på kort tid får svaret 429 och får vänta en stund innan den fortsätter.
