Integrationsanvändare (API-nyckel)

I Kleer kan du hantera API-nycklar för integrationer.

En API-nyckel kopplas till en användare och styr vad integrationen får göra – till exempel skapa verifikat, skapa leverantörsfakturor eller få tillgång till databasen (används bland annat för åtkomst till SQL Analytics). Den här guiden beskriver hur du ser dina integrationsanvändare, aktiverar (genererar) en nyckel och återkallar en nyckel.

Jag behöver en API-nyckel, hur får jag en?

Svaret beror på om integrationsanvändaren redan finns.

Finns den redan ser du den under Inställningar > Integrationsanvändare, och då genererar du nyckeln själv. Se Aktivera (generera) en nyckel nedan. Du behöver inte kontakta Kleer för det.

Finns den inte behöver den läggas upp, och det gör Kleer. Hör av dig via Kontakt och support, eller be din Kleer-konsult skicka förfrågan vidare. Välj en av vägarna, inte båda, så att samma förfrågan inte hanteras på två håll.

Det här behöver framgå av förfrågan

Vilket bolag det gäller.
Vad integrationen ska göra, alltså vilket system den ska koppla mot och vilken data den behöver.
Ett mobilnummer som nyckeln kan skickas till. Skapar Kleer nyckeln åt dig skickas den som SMS, inte med mejl.

Utöver nyckeln behöver den som bygger integrationen bolagets företagsnummer, som står på sidan Integrationsanvändare, samt adressen till API och dokumentationen. Be om det i samma förfrågan så slipper du en extra vända.

Bygger du integrationen åt en kund?

Har du som leverantör ingen egen inloggning i Kleer kan du inte se företagsnumret eller generera nyckeln. Gå då via kunden, eller via kundens Kleer-konsult, som har åtkomsten.

Var hittar du dina integrationsanvändare

Gå till Inställningar.
Välj Integrationsanvändare. Här ser du integrationsanvändarna för företaget.
På sidan visas Företagsnummer – det numret behöver kommuniceras till kund för att integrationer ska kunna utföras.

Kolumnerna i listan

För varje integrationsanvändare visas bland annat:

Användare – vem nyckeln tillhör.
Beskrivning – fritextbeskrivning av nyckeln.
Skapa verifikat – om nyckeln får skapa verifikat.
Skapa leverantörsfakturor – om nyckeln får skapa leverantörsfakturor.
Tillgång till databas – om nyckeln ger åtkomst till databasen.
Databas användarnamn – det användarnamn som används för databasanslutningen.
Betalrätt – om nyckeln har betalrätt.
Aktiv – om nyckeln är aktiv eller återkallad.

Aktivera (generera) en nyckel

Hitta den integrationsanvändare som är återkallad eller saknar aktiv nyckel.
Klicka på Aktivera.
Den genererade nyckeln visas på skärmen i dialogen Genererad nyckel.
Skriv av eller kopiera nyckeln direkt. Ingen på Kleer känner till nyckeln, och den visas bara denna gång.
Stäng dialogen genom att trycka ESC eller klicka på krysset.

Återkalla en nyckel

Hitta den aktiva integrationsanvändaren.
Klicka på Återkalla.
Bekräfta i frågan Återkalla nyckel?.
När du återkallar nyckeln slutar alla integrationer som använder den att fungera. Behöver du en ny nyckel efteråt klickar du på Aktivera igen.

Historik

Klicka på användarnamnet i listan för att öppna Historik.
Här ser du händelser som inträffat: när ändringar skett och vem som utfört dem.

Bra att veta

Företagsnumret måste kommuniceras till kund för att integrationer ska kunna utföras.
Tillgång till databas används bland annat för SQL Analytics. För nycklar med databasåtkomst finns ytterligare inställningar som säker anslutning, max antal anslutningar och max antal frågor i timmen.
Av säkerhetsskäl kan Betalrätt endast ändras av särskilda personer på Kleer.
API skapade innan 2020 kan behöva ses över. Om du ser användare som inte längre har behov av sitt API, kontakta Kleer.