Hur man kommer igång med SignInSimplys API ⚙️

Av

SignInSimply har ett modernt och enkelt REST API som tillåter dig att programmatiskt hämta och läsa in data från tjänsten. Den här guiden kommer att visa dig hur du kommer igång med API:et med exempel från API-testverktyget Bruno, men stegen är i princip desamma för andra verktyg, t.ex. Postman.

Hur du sedan bygger en produktionsfärdig version av din integration beror helt på vilket system du vill koppla till, hur dess API ser ut, och hur din IT-miljö fungerar.

En fullständig beskrivning av SignInSimplys API och alla dess metoder finns här.

URL:er och testmiljö

SignInSimply har en testmiljö med URL test.signinsimply.com. Testmiljön uppdateras med data från produktionsmiljön varje måndag kl. 01:00 CET. All data i testmiljön är en exakt kopia av produktionsmiljön förutom personuppgifter tillhörande besökare och användare utan adminbehörighet - dessa maskeras genom att omvandlas till en serie slumpmässiga tecken.

Vi rekommenderar alltid att alla API-tester görs mot testmiljön, och därför kommer alla anrop i denna guide att göras mot den, men anrop mot produktionsmiljön fungerar exakt likadant förutom att man byter ut URL:en test.signinsimply.com mot signinsimply.com.

Inloggning

Först loggar in på tjänsten för att hämta en autentiseringscookie som sedan måste inkluderas i samtliga efterföljande anrop. Inloggning sker genom att POST:a e-postadress och lösenord i “Multipart Form”-format till https://test.signinsimply.com/api/authentication/login. Notera att det endast går att logga in på API:et med en användare som har adminbehörighet - läs mer om SignInSimplys systemroller här.

Du är nu inloggad, och cookien “sis_session” är satt. Bruno tar automatiskt med den i efterföljande anrop. I en produktionsintegration måste man själv bygga en mekanism som sparar undan cookien och “injicerar” den i efterföljande anrop.

Exempelanrop för att lägga till en användare

Man kan lägga till användare genom att POST:a till URL:en https://test.signinsimply.com/api/users. Se dokumentationen för att se en lista på alla parametrar, vilka som är obligatoriska etc.

Svaret kommer att innehålla en “success”-parameter och, om anropet lyckas, en dataparameter som innehåller den skapade användaren, inklusive dess användar-ID.

Exempelanrop för att hämta besöksloggen

Besöksloggen hämtas genom ett GET-anrop till URL:en https://test.signinsimply.com/api/visits. Perioden man vill hämta besöksloggen för anges i URL:en med GET-parametrar. Ett fullständigt URL-exempel är https://test.signinsimply.com/api/visits?from_date=2025-01-01%2000%3A00%3A00&to_date=2026-06-30%2000%3A00%3A00.

Precis som tidigare, om anropet lyckas, kommer svaret innehålla en dataparameter med alla besök för den valda perioden.

Och det var allt! Enkelt och smidigt.

Kommentarer

Skicka en kommentar

Populära inlägg i den här bloggen

Vinteruppdateringen är här! 🎉

Av
Bild
I den här uppdateringen har vi lagt till en rad efterfrågade funktioner, bl.a. möjligheten för värdar att logga in och hantera sina egna förregistrerade besök, möjlighet att skapa långtids-QR-koder samt en ny roll, "Granskare", som endast kan hantera besöksloggen och förregistrerade besök. Läs mer nedan! Vi har gjort många förändringar under huven i denna uppdatering, och även om vi har gjort vårt allra yttersta för att testa igenom alla scenarion så kan det ha slunkit igenom en eller annan bugg. Vänligen kontakta oss om du upptäcker några felaktigheter. Värdar kan nu logga in och hantera sina egna förregistrerade besök Tidigare har värdar inte kunnat logga in, utan de lades endast in i systemet för att kunna ta emot besök. Numera kan de även logga in i systemet för att  lägga till, ta bort, ändra och checka in sina egna förregistrerade besök.  Om värden har en korrekt installerad Dymo-skrivare kopplad till sin dator kan de även skriva ut namnskyltar till besökarna. För ...
Läs mer

Glöm inte vår kom-igång-guide och videos 🎞️

Av
Bild
SignInSimply är ett besökssystem som uppdateras jämt och ständigt med både stora och små förbättringar, och det är lätt att missa nya funktioner som man kan ha nytta av. Som tur är uppdaterar vi också vår kom-igång-guide med allt nytt så att man kan läsa på om alla våra funktioner i lugn och ro. Ni hittar alltid vår kom-igång-guide i SignInSimplys sidfot, och glöm inte våra översiktsvideos som finns på förstasidan.  
Läs mer

Kom ihåg att hålla era faktureringsuppgifter och användarroller uppdaterade 🗂️

Av
Bild
Hej på er! Här kommer en liten påminnelse om varför det är viktigt att hålla era faktureringsuppgifter och användarroller uppdaterade i systemet. Faktureringsuppgifter Vår faktureringsprocess är delvis automatiserad och våra system utgår ifrån de faktureringsuppgifter som kunden/ni har angivit i SignInSimply under Administration → Företagsinfo . För att hela flödet ska bli rätt, och för att vi ska ha en korrekt logg på när och av vem grundläggande företagsuppgifter har ändrats, är det viktigt att ni själva håller era faktureringsuppgifter uppdaterade i SignInSimply. Ni kan uppdatera dem enligt instruktionerna i vår FAQ .     Användarroller Personalförändringar sker hela tiden. Vissa slutar, andra går på föräldraledighet eller blir sjukskrivna osv. Det blir knepigt om det bara finns en person med tillgång till SignInSimply och de inte är på plats för att administrera systemet då vi av säkerhetsskäl kan vi inte ge andra användare administratörsbehörighet på egen begäran, ut...
Läs mer