Met de Transactie Export API kun je als organisatie geautomatiseerd alle transacties, zoals verwijzingen en advies consulten, ophalen. Hierdoor is een handmatige actie niet meer nodig in Regie. Wel is er technische kennis vereist om dit te ontwikkelen. Dit artikel legt uit welke licenties je nodig hebt, hoe je een API-sleutel aanmaakt en hoe je de export start.
Dit heb je nodig
- Een actief ZorgDomein-account
- Je hebt de rol Verantwoordelijk beheerder
- Een ondertekend addendum. Neem hiervoor contact op met je accountmanager
- De licentie APIKEY voor het beheren van sleutels
- De licentie EXTERNE_TRANSACTIE_EXPORT om de export-opdracht te activeren
Zo doe je het
Volg deze stappen om de export via de API op te kunnen halen.
API-sleutel aanmaken en configureren
- Log in op ZorgDomein
- Ga naar Organisatie & personen > API-sleutels
- Klik op de knop API sleutel aanmaken om een nieuwe API-sleutel aan te maken
- Configureer de toegestane IP-adressen of IP-ranges. De API kan alleen van de opgegeven IP-adressen worden aangeroepen
- Gebruik losse IP-adressen. Bijvoorbeeld 192.168.1.100
- Gebruik IP-ranges in CIDR-notatie. Bijvoorbeeld 192.168.1.0/24
- Sla de API-sleutel direct op een veilige plek op, bijvoorbeeld in een passwordmanager
Let op: Een API sleutel geeft toegang tot gevoelige transactiegegevens. Geef de sleutel alleen aan personen en organisaties die deze strikt noodzakelijk nodig hebben voor de inrichting van de koppeling. Deel een API sleutel nooit via onveilige kanalen zoals e-mail, WhatsApp of andere berichten services, maar gebruik specifieke tools voor het veilig delen van gevoelige informatie.
De export uitvoeren
De technische uitvoering van een export vind je op ZorgDomein Integrator.
Dit kun je verwachten
Na het uitvoeren van de aanroep gebeurt het volgende:
- Je ontvangt de data in csv format
- De export bevat de transacties van de opgegeven datum
- Als je een 401-foutmelding krijgt, is de API-sleutel onjuist of het IP-adres niet geautoriseerd