SOAP API är en webservice API. Detta innebär att API:n är tillgänglig på internet och synlig för alla som vill granska den. API:n används genom att skriva en mjukvara som ansluter till den och interagerar med API:n. För att integrera med Severa behövs en API-nyckel. Utan den är det inte möjligt att använda API:n. Så även om API:n i sig är offentlig, är dess användning begränsad till organisationer som har Severas API-tillägg aktiverat och som har skapat och aktiverat API-nyckeln i integrationsprogrammet.
Kortfattat är stegen som behövs för integration:
Definiera behoven för integrationen. Behövs till exempel inmatning av arbetstimmar eller överföring av fakturor?
Kontrollera om SOAP API:n har de nödvändiga gränssnitten och alternativen för integrationen. Använd API-dokumentationen tillsammans med Severa-miljön för att få den nödvändiga informationen.
Om du integrerar med en annan mjukvara, kontrollera också att det finns en API eller någon annan metod för önskad interaktion på den andra sidan.
Om allt verkar bra, skapa en mjukvara som ansluter till API:n och utför integrationen. Ofta behövs en server där integrationen körs. Det är också rekommenderat att övervaka och logga eventuella integrationsfel.
SOAP API:n är passiv, vilket innebär att integrationsmjukvaran måste anropa API:n för att utföra en funktion och vänta på API:ns svar för att se om det lyckades.
Klicka här för mer information och instruktioner (Endast på engelska).
API: n konfigurering för din organisation
För att kunna integrera med Severa måste du aktivera API:n i din Severa-organisation.
Vi rekommenderar att skapa en API-användare i Severa som inte är en anställd i organisationen. Detta av två skäl:
Det behövs för att ge API-nyckeln till en användare med omfattande behörigheter i Severa, eftersom det är viktigt att få rätt information ut ur programmet. All data som erhålls från API:n är begränsad av användarens åtkomsträttigheter vars API-nyckel används.
När API-användaren inte är en anställd i organisationen finns det inte lika mycket behov av att hålla reda på vilken användares API-nyckel som används, och vilka behörigheter denna användare har eller om denna användare fortfarande är anställd i företaget. För att integrationerna ska fungera måste API-användaren vara aktiv hela tiden, så om API-nyckeln har skapats för en viss anställd, slutar integrationen att fungera om användaren inaktiveras.
När API-användaren har skapats och API:n aktiverats, genereras en API-nyckel för användaren. Denna API-nyckel används i integrationsmjukvaran och identifierar den som gör API-anropet och användarens organisation, vilket säkerställer att data returneras korrekt.
Om API-nyckeln förnyas för användaren, måste den uppdateras i mjukvaran som integreras med Severa.