De SOAP API is een webservice-API. Dit betekent dat de API op het internet beschikbaar is en zichtbaar is voor iedereen die deze wil bekijken. De API wordt gebruikt door er software voor te coderen die een verbinding met de API maakt en er interacties mee heeft. Om met Severa te integreren, is een API-sleutel vereist. Daarzonder is het niet mogelijk om de API te gebruiken. Dus ook al is de API zelf openbaar, het gebruik ervan is beperkt tot de organisaties die de add-on API van Severa hebben ingeschakeld en die een API-sleutel hebben gegenereerd, en deze sleutel in de integratiesoftware in gebruik hebben genomen.
In het kort zijn dit de stappen voor het integreren:
- Definieer het doel van de integratie. Is deze bijvoorbeeld nodig om werkuren in te voeren of facturen over te brengen?
- Onderzoek of de SOAP API over de benodigde interfaces en opties voor de integratie beschikt. Verkrijg deze kennis door de API-documentatie in samenhang met de Severa-omgeving te bestuderen.
- Als u met andere software integreert, onderzoek dan ook of die andere software een API of een andere methode biedt voor het tot stand brengen van de gewenste interactie.
- Als alles in orde lijkt te zijn, bouw dan software die een verbinding maakt met de API en de integratie tot stand brengt. Vaak is er een server nodig waarop de integratie wordt uitgevoerd. Het wordt ook aanbevolen om mogelijke integratiefouten op te sporen en vast te leggen.
- De SOAP API is passief, wat betekent dat de integratiesoftware de API moet aanroepen om een actie uit te voeren en op de reactie van de API moet wachten om te zien of deze succesvol was.
- Klik hier voor meer details en instructies (alleen in het Engels).
Om met Severa te kunnen integreren, moet de API in uw Severa-organisatie worden ingesteld.
- Het wordt aangeraden om in Severa één API-gebruiker aan te maken die geen medewerker van de desbetreffende organisatie is. Dit heeft twee redenen:
- De API-sleutel moet aan een gebruiker worden gegeven die uitgebreide toegangsrechten voor Severa heeft, omdat het belangrijk is dat de juiste gegevens uit uw software worden opgehaald. Alle gegevens die de API ophaalt, worden beperkt door de toegangsrechten van de gebruiker wiens API-sleutel wordt gebruikt.
- Wanneer de API-gebruiker geen medewerker van de organisatie is, is er minder noodzaak om bij te houden van welke gebruiker de API-sleutel wordt gebruikt, wat de toegangsrechten van die gebruiker zijn, en of die gebruiker nog steeds voor het bedrijf werkt. Om integraties te laten werken, moet API-gebruiker voortdurend actief zijn. Als dus de API-sleutel voor een medewerker wordt gegenereerd, dan werkt integratie niet wanneer die gebruiker niet actief is.
- Wanneer de API-gebruiker is aangemaakt en de API is ingeschakeld, wordt er een API-sleutel voor de gebruiker gegenereerd. Deze API-sleutel wordt in de integratiesoftware gebruikt en identificeert zowel de gebruiker die de API-oproep doet als de organisatie van de gebruiker, zodat de gegevens correct worden opgehaald.
- Als de API-sleutel voor deze gebruiker opnieuw wordt gegenereerd, dan moet de API-sleutel in de software die met Severa is geïntegreerd, ook worden bijgewerkt.
Was dit antwoord nuttig? Ja Nee
Feedback versturen