SDB ECD API gebruiken via Microsoft Visual Studio Code

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

  1. Installeer Microsoft Visual Studio Code via https://code.visualstudio.com/download.
  2. Nadat je Visual Studio Code hebt geïnstalleerd, voeg je de zogenaamde REST Client extensie toe.
    1. Open Visual Studio Code.
    2. Ga in het menu naar View - Extensions of maak gebruik van Ctrl+Shift+X.
    3. Zoek via het Extensions zoekveld naar "REST Client".
    4. Selecteer uit de lijst de REST Client van uitgever "Huachao Mao".
    5. Klik op [Install] om de extensie te installeren.

2. Configuratie

  1. Download de http bestanden van de SDB ECD API swagger website.
  2. Pak het ZIP-bestand uit.
  3. Ga in Visual Studio Code naar File en kies voor "Open Folder".
  4. Selecteer de map waarin het ZIP-bestand werd uitgepakt.
  5. Selecteer in die map het bestand ".vscode/settings.json".
  6. Aan de linkerkant kun je dat bestand selecteren.

  7. Configureer vervolgens de volgende waarden voor de omgevingen aan de rechterkant.  Standaard zijn de volgende omgevingen opgenomen: acc (acceptatie) en prod (productie).  Mogelijk heb je niet al die omgevingen nodig.  Voel je dus vrij om een omgeving te verwijderen.
  8. Per omgeving dien je de configuratie vervolgens te voltooien:

    1. tenant: naam van jouw organisatie.  Dit is altijd de naam uit de SDB ECD URL.  De tenant in https://kompas.sdbecd.nl/ is "kompas".
    2. username: SDB ECD gebruiker waarmee je SDB ECD API wilt benaderen.
    3. password: wachtwoord van die gebruiker.
    4. client_secret: beveiligde sleutel om toegang te krijgen tot de omgeving.  Je kunt de sleutel aanvragen via een ticket in het klantenportaal.
    5. clientId: cliëntnummer waarvoor je (standaard) de bevragingen uit wilt voeren.
    6. employeeId: medewerkernummer waarvoor je (standaard) de bevragingen uit wilt voeren.

3. Uitvoeren van API

  1. Selecteer in Visual Studio Code het http bestand aan de linkerkant.

  2. Selecteer helemaal rechts onderin de omgeving.

  3. Voer eerst de GetToken bevraging uit door op [Send Request] te drukken
  4. Ga naar een willekeurige andere API bevraging en druk op [Send Request]
    • Related Articles

    • Chatten via SDB Octopus: CliëntApp

      Met de chatmodule in de SDB CliëntApp is het mogelijk om op een veilige en eenvoudige manier te communiceren met de zorg. Deze functionaliteit is speciaal ontwikkeld om laagdrempelig contact mogelijk te maken, rechtstreeks vanuit de CliëntApp. De ...
    • Ysis koppeling

      Doelstelling Samen met Gerimedica is een koppeling ontwikkeld tussen het SDB ECD en Ysis. Via deze koppeling wordt cliëntinformatie tussen beide systemen uitgewisseld. Het doel van de koppeling is om de geregistreerde gegevens in beide systemen ...
    • Hyperlinks aanmaken

      Soms is het handig om voor een cliënt snel naar een pagina buiten SDB ECD te navigeren. Dit kan via hyperlinks, die worden getoond in Cliëntacties. Hyperlinks aanmaken Ga naar Meer → Beheer → Stambestanden → Hyperlinks Maak een cliëntgerelateerde ...
    • Informatiebulletin PGO ontsluiting SDB ECD

      Wat is PGO ontsluiting? Een PGO staat voor Persoonlijke Gezondheidsomgeving. Elke Nederlander heeft het recht om via een zelf gekozen PGO informatie op te vragen bij alle zorgprofessionals waar hij/zij in behandeling is (geweest). Concreet kan je als ...
    • Inzicht in CliëntApp-toegang via overzicht Netwerk

      Inzicht in CliëntApp-toegang via overzicht Netwerk Via het overzicht Netwerk kun je controleren of een betrokkene toegang heeft tot de CliëntApp. Je vindt dit overzicht als volgt: Ga naar Overzichten Selecteer het overzicht Netwerk In dit overzicht ...