Behöver du integrera Freja eID i en app eller på webben? En integration via Freja eID Integration API är:
Driftsäker
Snabb
Enkel
Freja Integration API
Ett driftsäkert, snabbt och enkelt API för att integrera Freja eID
Marknadens enklaste Freja-API - ca 5 minuters integration (Frejas eget API tar ca 100 h att integrera)
Inga virtuella maskiner eller certifikatshantering = inga skenande konsultkostnader
BankSignering är återförsäljare hos Freja eID, vilket innebär att ni enbart behöver ha kontakt med oss
Dedikerad supporttekniker
Driftsäker, snabb och säker hantering av anrop och data
↓ Klicka här för beskrivning av endpoints↓
Behöver ni integrera Freja eID i ert system? Vårt API är enkelt, säkert och mycket snabbt att integrera - en erfaren programmerare bör kunna göra en första signering eller autentisering inom 5 minuter, oavsett programmeringsspråk.
API:t har två endpoints: 1) FrejaAuth/FrejaSign: Används för att autentisera en användare eller för att signera en text eller ett dokument. Du får tillbaka en orderreferens, en autostarttoken och en url till en QR-kod. De använder du sedan för att hämta status för signeringen, skapa en länk till Freja-appen eller visa en QR-kod som öppnar Freja-appen.
2) FrejaCollectStatus: Används för att hämta status för en signering eller autentisering. Om en signering eller autentisering är under behandling får du status och en "hintCode" som beskriver var i processen användaren befinner sig. När en signering eller autentisering är klar får du personnummer och namn på personen, och för en signering även Freja eID:s signatur som bevis på signeringen.
Nedan följer exempelkod med förklaringar av vilken data som krävs. Kontakta oss gärna om du vill veta mer!
1) FrejaAuth/FrejaSign endpoint (POST)
FrejaAuth/FrejaSign endpoint JSON:
{
"apiUser":"xxx", // String - username given by BankSignering "password" : "yyy", // String - password guid given by BankSignering "companyApiGuid" : "zzz", // String - company guid given by BankSignering
"userVisibleData" : "Text to sign", // Optional string - If text is to be signed, this is the text shown when signing in the Freja app. Max 4096 characters. Only used by FrejaSign "userNonVisibleData" : "Non visible text to sign" // Optional string - Text to send to Freja eID when signing for example a PDF. Only used by FrejaSign
}
FrejaAuth/FrejaSign endpoint response JSON:
{
"authResponse": {
"Success": true, // Bool - was the authentification with BankSignering successful? "ErrorMessage": null // String - If something went wrong, what went wrong?
}, "apiCallResponse": { // Null if authentification fails
"Success": true, // Bool - was the send successful? "StatusMessage": "Freja signature initiated", // String - How did the call go? And if something went wrong, what went wrong? "Response": {
"OrderRef": "W5IJKBH95h9KRhICimRia5otxkVuP36Aw5CRLYOteIQfx4bpfmvDnW7AbDugMjIa", // String - The reference to use when getting the sign status later. Note that it is 64 characters long "AutoStartToken": "W5IJKBH95h9KRhICimRia5otxkVuP36Aw5CRLYOteIQfx4bpfmvDnW7AbDugMjIa" // String - Use this to forward the user directly to the Freja app. The AutoStartToken is valid 2 minutes after the sign is created. Click here for info on how to create the link. "QrImage": "https://api.banksign.com/frejaqr/W5IJKBH95h9KRhICimRia5otxkVuP36Aw5CRLYOteIQfx4bpfmvDnW7AbDugMjIa" // String - Url to a QR code image. The user scans the QR code with the Freja app to start the sign. The QR code is valid 2 minutes after the sign is created
}
}
}
2) FrejaCollectStatus endpoint (POST)
Freja CollectStatus endpoint JSON:
{
"apiUser":"xxx", // String - username given by BankSignering "password" : "yyy", // String - password guid given by BankSignering "companyApiGuid" : "zzz", // String - company guid given by BankSignering
"orderRef" : "W5IJKBH95h9KRhICimRia5otxkVuP36Aw5CRLYOteIQfx4bpfmvDnW7AbDugMjIa", // String - the orderRef from the response when posting to the FrejaAuth/FrejaSign endpoint
}
FrejaCollectStatus endpoint response JSON:
{
"authResponse": {
"Success": true, // Bool - was the authentification with BankSignering successful? "ErrorMessage": null // String - If something went wrong, what went wrong?
}, "apiCallResponse": { // Null if authentification fails
"Success": true, // Bool - was the send successful? "StatusMessage": "complete", // String - How did the call go? And if something went wrong, what went wrong? "Response": {
"OrderRef": "W5IJKBH95h9KRhICimRia5otxkVuP36Aw5CRLYOteIQfx4bpfmvDnW7AbDugMjIa", // String - The reference used when getting the status "Status": "complete" // String - The current status of the orderRef: "pending", "failed" or "complete" "HintCode": "null" // String - Hint for pending calls: "outstandingTransaction" or "userSign". For failed calls: "expiredTransaction", "userCancel" or "cancelled". "CompletionData": {
"signJws": "*JWS signed by Freja eID*", // JWS string - The signature data sealed by Freja eID: who signed, when, the signed data and an OCSP response. Only set for signatures. "user": {
"personalNumber": "195511237794", // String - The swedish social security number returned by the Freja eID service "name": "Karl Svensson", // String - User full name "givenName": "Karl", // String - User first name "surname": "Svensson" // String - User surname
En url kan skapas av den autostarttoken man får i svaret från FrejaAuth/FrejaSign-anropet. Autostarttoken ska url-kodas, enligt Freja eID:s rekommendation.
URL-syntaxen som Freja eID rekommenderar: https://app.prod.frejaeid.com/freja?action=bindUserToTransaction&transactionReference=[TOKEN]&originAppScheme=[RETURNURL]
Alternativ URL-syntax: frejaeid://bindUserToTransaction?transactionReference=[TOKEN]&originAppScheme=[RETURNURL]
Notera att https-länken öppnar Freja-appen om den är installerad, och annars en sida för att ladda ner appen. originAppScheme är valfri och anger vart användaren skickas tillbaka efter autentiseringen eller signeringen.
Offertförfrågan
Fyll i dina företagsuppgifter så skickar vi en offert inom 24 h
Vi använder cookies på vår webbplats för att se hur du interagerar med den samt för att kunna särskilja våra driftmiljöer. När du trycker på Godkänn samtycker du till vår användning av cookies.
Läs vår cookiepolicyJag godkänner användande av cookies
