In het zorgproces kan er behoefte zijn aan een aanvullende softwaredienst vanuit een externe softwareontwikkelaar. Via een API-koppeling kan deze softwaredienst met Ons communiceren. De externe applicatie kan hiermee specifieke gegevens ophalen, plaatsen en updaten door het aanroepen van opengestelde API endpoints. Bijvoorbeeld door het ophalen van cliënt- of medewerkernummers of het bijwerken van een contactpersoon in Ons vanuit de externe applicatie. Deze gegevensuitwisseling kan pas plaatsvinden nadat een koppeling door ons is goedgekeurd (reviewproces) en de zorginstelling goedkeuring heeft gegeven om de koppeling tot stand te brengen in Ons® Podium.
Meer technische informatie hierover vind je op www.ons-api.nl.
Inloggen in het Ons® API Dashboard
Het Ons® API Dashboard is een webpagina voor externe softwareleveranciers om API-koppelingen te beheren. Om gebruik te maken van het Ons® API Dashboard heb je inloggegevens nodig. Deze ontvang je zodra je bij ons bekend bent als externe koppelpartner. Is de link in de activaitemail verlopen? Gebruik dan de Forgot Password? knop op het login-scherm. Heb je geen activatiemail ontvangen of heb je andere vragen rondom het inloggen? Neem dan via een supportticket contact met ons op.
API-koppelingen aanvragen, activeren, gebruiken en opheffen
Let op! Sinds vrijdag 5 september 2025 is de werkwijze van API koppelingen activeren veranderd. Een externe softwareleverancier hoeft geen ticket meer aan te maken bij support voor de goedkeuring van de API koppeling vanuit de zorgaanbieder. De zorgaanbieder kan dit nu zelf goedkeuren vanuit Ons® Podium in de productieomgeving. Ook wanneer de koppeling voor een testomgeving bedoeld is. Zie de documentatie over Ons® Podium voor meer informatie.
Een reeds bestaande API koppeling aanvragen en goedkeuren
Voor het aanvragen van bestaande goedgekeurde koppelingen moeten de volgende stappen worden doorlopen:
- Neem contact op met de externe softwareleverancier. Zij moeten het technische deel van de koppelingsaanvraag afhandelen. Geef hun de volgende gegevens door:
Klantcode van de Ons-omgeving. Deze vind je via
.Betreft het een koppeling die getoond wordt onder het tabblad 'Koppelingen'? Dan is deze koppeling van een Ons® Podium partner en kan de aanvraag voor de koppeling volledig via Ons® Podium afgehandeld worden. In deze handleiding lees je hoe dit kan worden gedaan.
De externe softwareleverancier voegt in het Ons® Api Dashboard een certificaat toe waarmee ze kunnen koppelen met jullie Ons® omgeving(en).
Hierna is in Ons® Podium op de productieomgeving het koppelverzoek zichtbaar onder het tabblad 'Dashboard'. Klik bij de desbetreffende koppeling op 'Bekijk details'. Controleer of de koppeling met de juiste omgeving(en) gaat koppelen en of de gewenste data wordt opgehaald of wordt weggeschreven.
Klik op bevestigen om de nieuwe koppeling, of de nieuwe versie van de bestaande koppeling, te accorderen.
De toestemming voor de koppeling is nu vastgelegd. De externe partij kan het benodigde certificaat vanaf nu downloaden en de koppeling daadwerkelijk gaan benutten. Dit certificaat is altijd maximaal een jaar geldig. De externe softwareleverancier dient dit bij te houden en het certificaat bij tijds te vernieuwen.
Opheffen van een gebruikte API-koppeling
Op dit moment kunnen actieve API-koppelingen nog niet worden gedeactiveerd vanuit Ons Podium. Dit wordt in de toekomst mogelijk gemaakt. Tot die tijd dient dit aangegeven te worden bij de externe partij. Zij kunnen vervolgens het gebruikte certificaat deactiveren.
Let op! Na deze handeling blijft de koppeling nog wel zichtbaar in het overzicht van koppelingen in Ons Diensten. Hiervoor moet de door de zorgaanbieder gegeven toestemming om te koppelen worden ingetrokken. Dit kun je doen door een ticket aan te maken bij Healthcare Support.
Indien de koppeling nog gebruikt wordt, maar de toestemming wordt ingetrokken, dan wordt ook de algehele koppeling stopgezet. Dit gebeurt dan echter zonder dat de externe partij geïnformeerd wordt.
Nog niet bestaande, nog niet goedgekeurde koppelingen aanvragen
Wil je een koppeling met Ons realiseren voor jullie zorgorganisatie? Vraag dan je leverancier om een koppeling met Ons te maken. Het is voor alle leveranciers van applicaties mogelijk om een koppeling met Nedap Ons op te zetten.
Ben je als leverancier geïnteresseerd om een nieuwe koppeling te realiseren? Ga dan voor meer informatie naar www.ons-api.nl of meld je direct aan via https://api-dashboard.ons.io/intake.
Wij bieden ook een mogelijkheid om gegevens te importeren via XML-importbestanden. Het kan zijn dat een leverancier geen koppeling op basis van de Ons-API heeft, maar wel via de XML-import. Zie voor meer informatie: Gegevens importeren via XML-bestanden
Problemen met API-koppelingen oplossen
Het kan gebeuren dat het niet lukt om een koppeling tot stand te brengen, of dat er fouten met de koppeling optreden. Hieraan kunnen verschillende oorzaken ten grondslag liggen. Een aantal voorbeelden zijn:
Gegevens komen niet, of onjuist over via de koppeling.
Het certificaat is niet aangevraagd, of is verlopen en moet aangevraagd of vernieuwd worden.
Een oudere versie van een koppeling wordt gebruikt.
We adviseren om bij dergelijke situaties, of bij vragen over de algehele werking van een koppeling, altijd eerst de ontwikkelaar van deze koppeling te benaderen. Zij kunnen de werking van deze koppeling nalopen en indien nodig Support benaderen met technische aanvullingen.
Bestaande koppelingen
Hieronder de lijst van partijen met tenminste één actieve Ons® API koppeling. Deze partijen hebben een koppeling met minimaal 1 zorgorganisatie. Op Ons® Podium vind je koppelpartners die bewezen samenwerken met de Ons® Suite:
Deze lijst is laatst bijgewerkt op 11 september 2025.