Vad är ett API?

Ett API är ett sätt för olika program och system att prata med varandra. Förkortningen står för Application Programming Interface. När vi på e-identitet talar om API:er för integrationer menar vi oftast webb-API:er. Det är digitala gränssnitt som system använder för att hämta eller skicka data över internet. Här går vi igenom vad ett API är, hur det fungerar, och vilka API:er vi erbjuder för inloggning och e-signering.

Hur fungerar ett webb-API?

Ett webb-API bygger på enkla anrop och svar. Ert system skickar ett anrop till en bestämd adress hos en annan tjänst och får tillbaka ett svar med den data ni bad om. Den vanligaste varianten kallas REST. Den bygger på webbens egna standarder, där anropen går över HTTP, samma protokoll som er webbläsare använder. Systemen skickar oftast datan i formatet JSON, ett textformat som är lättläst för både människor och maskiner.

Poängen är att ni slipper veta hur det andra systemet fungerar inuti. Ni behöver bara känna till vilka anrop som finns och vilken data de väntar sig. Då kan två system samarbeta även om de är byggda i olika tekniker, av olika leverantörer.

Ett konkret exempel: När en användare loggar in på er e-tjänst skickar ert system ett anrop till vårt eID API. Tjänsten sköter kommunikationen med BankID och svarar med vem användaren är. Er e-tjänst behöver aldrig hantera själva BankID-kommunikationen.

Varför är API:er användbara?

Med ett API kan ni låta era system sköta sådant som annars kräver manuellt arbete. I stället för att någon loggar in i en tjänst, fyller i uppgifter och för över resultatet för hand, gör systemen det åt er. Det ger framför allt tre fördelar:

• Automatisering: Återkommande uppgifter, som att skapa ett avtal när ett nytt ärende uppstår, sker av sig själva.
• Färre fel: När data flödar direkt mellan systemen slipper ni dubbelregistrering och de misstag som lätt uppstår vid manuell överföring.
• System i synk: Era system håller samma information uppdaterad, i realtid.

Därför har API:er blivit en helt central del i hur moderna system kopplas ihop.

Öppna och stängda API:er

Det finns två huvudtyper av API:er: öppna och stängda. Ett öppet API har publik dokumentation, så att vem som helst kan bygga mot det. Ett stängt API används bara internt eller av utvalda partner. Våra API:er har öppen och publik dokumentation. För att skydda känslig information kräver vi dock att ni identifierar er med en API-nyckel innan systemen kan prata med varandra. På så sätt kombinerar vi öppenheten som integratörer behöver med kontroll över vem som ser era data.

Våra API:er

Hos oss finns två API:er att känna till: eID API:et för inloggning och signering, och eAvtal API:et för avtalshantering. eID API:et är utgångspunkten för nästan alla våra integrationer. Ni kan använda eAvtal direkt i webbkontoret eller via vårt API. Valet beror på om ni vill arbeta direkt i tjänsten eller bygga in avtalshanteringen i era egna system.

eID API: smidig integration med robust säkerhet

Vårt eID API hanterar inloggning och signering med e-legitimation. Det fungerar som en brygga mellan era e-tjänster och alla godkända e-legitimationer. Styrkan ligger i tekniken bakom: vi kan skräddarsy integrationen och till exempel koppla specifik användarinformation efter era behov.

Vi har byggt API:et för att det ska vara enkelt för er att införa. I dokumentationen ser ni att ni i grunden bara behöver två anrop:

• FederatedLogin: Startar inloggnings- eller signeringsprocessen och skickar användaren vidare.
• GetSession: Hämtar användarens uppgifter när hen kommer tillbaka.

Den fullständiga dokumentationen finns här

eAvtal API: signering inbyggd i era egna system

Vårt eAvtal API är ett REST-API för hela avtalets livscykel. Det låter er skapa, skicka, signera, följa och hämta avtal direkt från era egna system, utan att någon växlar till en separat webbtjänst. Oftast kopplar ni in eAvtal i de system där avtalen redan uppstår: kundsystem (CRM), affärs- och ekonomisystem (ERP), HR-system och fastighetssystem.

Med eAvtal API:et kan ni bland annat:

• Skapa och skicka avtal: Ladda upp dokument, lägg till parter och välj signeringsmetod för varje part.
• Följa status i realtid: Prenumerera på händelsenotiser (webhooks) för till exempel "avtal signerat" och "avtal klart", så att ert system reagerar automatiskt.
• Styra signeringsflödet: Använd returlänkar för att låta parten signera och sedan komma tillbaka till er egen webbplats.
• Hämta färdiga avtal: Ladda ner de färdiga PDF-dokumenten, med signaturer och bevisning inbyggda, till ert eget system eller arkiv.

Den fullständiga dokumentationen finns här

Vill ni veta mer?

Vill ni koppla inloggning, signering eller avtalshantering till era egna system? Hör av er till oss så hjälper vi er hitta rätt väg in. Ni kan också läsa mer om eAvtal och om våra integrationsprotokoll.