Via de AdminPulse API en webhooks kan je AdminPulse koppelen met andere software. Zo kan een andere toepassing gegevens uit AdminPulse ophalen, gegevens toevoegen of acties uitvoeren.
Je kan een standaardkoppeling bouwen die meerdere AdminPulse-kantoren kunnen gebruiken, of een eigen koppeling voor één kantoor.
In dit artikel lees je wat het verschil is, waar je de technische documentatie vindt en hoe je een API-sleutel aanmaakt.
Welke koppeling wil je bouwen?
Een standaardkoppeling als softwareleverancier
Ben je een softwareleverancier en wil je een koppeling aanbieden die meerdere AdminPulse-kantoren kunnen gebruiken? Raadpleeg dan eerst de AdminPulse-developerdocumentatie en dien een aanvraag in bij ons supportteam.
Beschrijf in je aanvraag kort welke koppeling je wil aanbieden en welke concrete usecases ze ondersteunt. Daarna nemen we contact met je op voor een intakegesprek waarin we de mogelijkheden en volgende stappen bespreken.
Een eigen koppeling voor één kantoor
Wil je AdminPulse voor eigen gebruik binnen één kantoor koppelen met andere software? Controleer dan eerst in Partners: overzicht van koppelingen met AdminPulse of er al een standaardkoppeling bestaat.
Bestaat er geen geschikte standaardkoppeling? Dan heb je twee mogelijkheden:
- Een eigen koppeling via de API en webhooks: je kantoor of je IT-partner bouwt een koppeling op maat.
- Zapier: verbind AdminPulse met heel wat andere toepassingen en stel automatische workflows in zonder zelf te programmeren. Lees meer in Zapier: Automatisaties bouwen tussen AdminPulse en andere software.
Wat zijn een API en een webhook?
Wat is een API?
Een API (Application Programming Interface) laat twee toepassingen met elkaar communiceren. Via de AdminPulse API kan een andere toepassing bijvoorbeeld relatiegegevens uitlezen, relaties of registraties toevoegen en de status van taken aanpassen.
Wat is een webhook?
Met een webhook brengt AdminPulse een andere toepassing automatisch op de hoogte wanneer er iets verandert. De toepassing hoeft daardoor niet telkens opnieuw aan AdminPulse te vragen of er nieuwe of gewijzigde gegevens zijn.
Een webhook kan bijvoorbeeld een gebeurtenis doorgeven wanneer een document, e-mail, factuur, registratie, relatie, taak, taakschema, to-do of gebruiker wordt aangemaakt, gewijzigd of verwijderd.
Je configureert webhooks via de API, niet via een scherm in AdminPulse.
Waar vind je de technische documentatie?
De AdminPulse-developerdocumentatie geldt voor zowel standaardkoppelingen als eigen kantoorintegraties. Je vindt er informatie over aanmelden bij de API, de beschikbare API-mogelijkheden, het instellen van webhooks, de opbouw van webhookberichten en de controle of een bericht daadwerkelijk van AdminPulse afkomstig is.
Hoe maak je in AdminPulse een API-sleutel aan?
Een API-sleutel geeft een andere toepassing toegang tot AdminPulse, binnen de rechten die het kantoor aan de sleutel toekent.
👉 Behandel een API-sleutel zoals een wachtwoord. Deel ze alleen op een veilige manier met de softwareleverancier of IT-partner die de koppeling beheert.
- Ga naar Mijn profiel > API-sleutels. Je kan de pagina ook rechtstreeks openen via API-sleutels in AdminPulse.
- Maak een nieuwe API-sleutel aan en geef deze een duidelijke Naam. Zo kan je later gemakkelijk herkennen waarvoor de sleutel wordt gebruikt.
- Kies een Vervaldatum die past bij de verwachte duur van de koppeling.
-
Selecteer bij Client het softwarepakket waarvoor je de API-sleutel aanmaakt.
Staat het softwarepakket niet in de lijst en bouw je een eigen koppeling? Kies dan Eigen kantoorintegratie.
- Ken alleen de rechten toe die de koppeling nodig heeft. Spreek met je IT-partner of softwareleverancier af welke rechten vereist zijn.