Detta dokument beskriver de tjänster som Pingaway erbjuder via öppna API. Tjänsterna är främst avsedda för 3:e partssystem som behöver integreras med Pingaway.

Läsaren av denna dokumentation bör känna till vanliga begrepp i våra tjänster (slutanvändarapplikationen (Home)) app.pingaway.se och relaterade teknologier före man påbörjar en implementation av en klient som använder dessa tjänster.

Ändringar och tillägg till vårt API dokumenteras på developer.pingaway.se

Vi förbehåller oss rätten att blockera användning av våra API om de strider mot våra användarregler.

Tillgång till vårt API

Pingaways API finns på https://admin.pingaway.se/api/
Alla API-metoders sökvägar är relativa till denna webbadress.

Autentisering och sessioner

När en användare (webbläsare eller API-klient) loggar in på Home med sitt användarnamn och lösenord returneras en sessionscookie som kommer att krävas för efterföljande förfrågningar. En enskild användare kan ha flera sessioner aktiva samtidigt utan begränsningar (även om de flesta webbläsare använder samma cookie om användaren har flera fönster/flikar öppna för att komma åt Hem). Alla förfrågningar till API:t som kräver autentisering men som ligger utanför en aktiv session kommer att besvaras med ett 401 obehörigt svar.

Synkronisering

Man måste ha i åtanke när man designar och anpassar system som integreras med Home att all data och konfiguration kan ändras från en annan källa. Därför rekommenderas att inte lagra en kopia av data som hämtas från Home såvida den inte läses in ofta och dess noggrannhet inte är avgörande, och när du uppdaterar information i Home rekommenderas det att informationen först uppdateras för att säkerställa att inga ändringar har gjorts från en annan källa sedan informationen först hämtades.

Teckenkodning och förfrågningsmetoder

Innehållstypen och kodningen för varje API-metod anges i Content-Type-svarshuvudet. De flesta av svaren är JSON-formaterade och alla är UTF-8-kodade.

Teckenkodningen som används i begärande URL:er är inte väldefinierad, vilket betyder att tecken som inte är US-ASCII kan utgöra ett problem och inte vara portabla. Vi rekommenderar starkt att du anger en lämplig innehållstyp i varje begäran.

Läs mer

Detta dokument beskriver de API som erbjuds som öppna API.

För mer information om JSON gå till http://www.json.org. Implementeringar är fritt tillgängliga för de flesta populära språken.

För att utforska vårt API i en webbläsare kan man använda det utmärkta Chrome-tillägget Postman. Den kan övervaka XmlHttpRequests som skickas av webbläsaren och genom att analysera dessa kan man få en bättre förståelse för hur API:et fungerar.