Werken met SDB ECD API

Werken met SDB ECD API

Werken met SDB ECD API

Dit artikel legt uit wat API's zijn, waarom ze binnen het ECD worden gebruikt en waar je de benodigde documentatie kunt vinden om ermee aan de slag te gaan.

Functionaliteit

Binnen het ECD kan het belangrijk zijn om gegevens uit te wisselen met andere applicaties. Denk hierbij aan:
  1. Gegevens uit het ECD toegankelijk maken voor externe systemen
  2. Gegevens toevoegen aan het ECD vanuit externe bronnen
Een gestandaardiseerde manier om dit veilig en betrouwbaar te doen, is via API's (Application Programming Interfaces). Hiermee kunnen systemen op een uniforme manier met elkaar communiceren.

Documentatie

Om optimaal gebruik te maken van de beschikbare API's is het belangrijk om de juiste documentatie te raadplegen. Deze bevat o.a. informatie over de beschikbare endpoints en benodigde parameters. De API-documentatie van het ECD is beschikbaar via Swagger. Hierin wordt een overzichtelijke, interactieve weergave getoond van de beschikbare API's.

Je kunt de API-documentatie openen via de Swagger-URL. Vervang in deze URL de waarden klantnaam en omgeving door de gegevens die van toepassing zijn binnen jouw organisatie:
https://klantnaam-api.omgeving-sdbecd.nl/swagger

Wanneer de pagina wordt geopend, verschijnt de volledige SDB ECD API documentatie. Deze biedt een volledig overzicht van alle beschikbare API-endpoints die door externe applicaties gebruikt kunnen worden om gegevens uit het ECD op te halen of te wijzigen. De documentatie is ingedeeld per onderdeel zoals bijvoorbeeld Activities, Changes en Clients.


Door op een onderdeel te klikken krijg je per endpoint inzicht in:
  1. Welke gegevens kunnen worden opgehaald of gewijzigd
  2. Welke parameters verplicht of optioneel moeten worden worden meegegeven
  3. Welke output het endpoint teruggeeft
  4. Welke retourcodes mogelijk zijn, inclusief de betekenis hiervan

Voordat je de API's in jouw applicatie of toepassing integreert, is het handig om eerst te testen welke output een specifieke API-functie precies oplevert. Maak hiervoor gebruik van Microsoft Visual Studio. In het artikel daarover beschrijven we welke stappen er genomen moeten worden om met dit programma verder kennis te maken met de API-bibliotheek die vanuit SDB ECD wordt aangeboden.


    • Related Articles

    • SDB ECD API gebruiken via Microsoft Visual Studio Code

      In dit artikel wordt uitgelegd welke stappen je dient te doorlopen om SDB ECD API te kunnen ontsluiten via Microsoft Visual Studio Code. Op die manier kun je zelf kennis maken met de API-bibliotheek die vanuit SDB ECD wordt aangeboden. 1. Installatie ...

    • Job 'SDB ECD -> AFAS'

      Er is een job binnen SDB ECD waarmee abonnementen en/of contracten kunnen worden geëxporteerd naar AFAS ten behoeve van de facturering. Job 'SDB ECD -> AFAS' Bij het aanmaken van de job dien je de volgende instellingen te kiezen: Start De maand vanaf ...

    • Wlz: URL Rekenmodule

      Vraag Hoe kan je bij een cliënt onder Diensten -> Wlz de rekenmodule instellen? Antwoord Binnen Beheer -> Parameters kan je de parameter 'URL Rekenmodule' instellen met de URL naar keuze, bv.: https://apps.vecozo.nl/RekenmoduleWLZ/

    • ECD: Bekende issues

      Graag brengen wij je op de hoogte van de volgende issue(s) die momenteel spelen binnen SDB ECD. Het betreft issues die bij ons bekend zijn en waarvan wij weten dat deze mogelijk bij meerdere klanten voorkomen. Door deze issues te bundelen, bieden wij ...

    • Werken met Episodes binnen SDB ECD

      Vraag Kan er binnen SDB ECD gebruik gemaakt worden van Episodes en hoe werkt dit dan? Antwoord Ja het is mogelijk om met episodes te werken. Dit zijn elementen die vooral door een behandelaar worden gebruikt en waaraan (PDA-)doelen kunnen worden ...