Een koppeling specificeren

Een koppeling wordt gespecificeerd via het functioneel ontwerp en Ons® API Models.

Functioneel ontwerp

Het functioneel ontwerp is een beschrijving van de versie van de connector.

De gegevens van de versie zijn alleen aan te passen als deze draft is. Controleer dus goed of alle informatie klopt, voordat je een versie vastzet.

Omschrijvingen

• Product description
  Hier geef je op welke diensten het achterliggende product biedt, niet zijnde de (versie van de) connector.

• Summarized connector description
  Hier geef je in 140 tekens aan wat deze (versie van de) connector doet.

• Connector description
  Hier geef je uitgebreid aan wat deze (versie van de) connector doet.

• What problem is being solved?
  Hier geef je aan wat de meerwaarde van de (versie van de) connector is.

Bij het maken van een nieuwe versie worden beschrijvingen automatisch overgenomen. Hiervoor geldt de laatste versie als bron.

Ons® API Models

Models zijn alleen te wijzigen wanneer de versie draft is.

In Ons® API Models specificeer je welke data uitgewisseld wordt. Dit doe je door modellen te selecteren en aan te geven welke operations en velden de koppeling nodig heeft.

Vanuit het data-minimalisatie-oogpunt is het belangrijk om alleen gegevens uit te wisselen die nodig zijn voor de daadwerkelijke koppeling; er mag geen data uitgewisseld worden die niet doelmatig is. Zie ook Dataminimalisatie / filtering.

CRUD Operations
Voor ieder model kun je selecteren welke CRUD (Create, Read, Update, Delete) operations je wilt kunnen uitvoeren. De beschikbare operations kunnen per model verschillen. Via het selecteren van de operations krijg je toegang tot de endpoints, Je hoeft dus niet te specificeren welke exacte endpoints je wilt gebruiken.

De lijst met beschikbare endpoints is te vinden op API’s.

Sandbox mode

Om tijdens het development-stadium het werk eenvoudiger te maken, is de schakelaar Sandbox mode aanwezig.

• Staat deze aan?
  Dan wordt er geen filtering toegepast en kunnen calls op alle endpoints worden gedaan.
  
• Staat deze uit?
  Dan wordt alleen data uitgewisseld die gespecificeerd is.

Sandbox mode moet uitgeschakeld zijn voordat een verzoek gedaan kan worden om de koppeling naar ontwikkelstadium ‘production’ te brengen.

---