Link Search Menu Expand Document

Staging en Productie

Staging

Je bent klaar met ontwikkelen op de development-omgeving en wil graag met een klant testen op staging. Doorloop de volgende stappen:

Goedkeuring van het technisch ontwerp aanvragen

Op de staging-omgevingen passen we dataminimalisatie toe. Dat betekent dat je koppeling alleen toegang krijgt tot die endpoints en velden die daadwerkelijk nodig zijn voor de werking van je koppeling. Als het goed is heb je tijdens het ontwikkelen al aangegeven welke endpoints je nodig hebt, dit noemen we het technisch ontwerp.

Als de knop ‘Allow all endpoints on development’ nog aan staat dan moet je deze eerst uitzetten en zorgen dat je alle benodigde endpoints en velden aangevraagd hebt.

Zo vraag je goedkeuring van je technisch ontwerp aan:

  1. Log in op het Ons API Dashboard
  2. Navigeer naar de koppeling die je aan het ontwikkelen bent
  3. Klik rechts bovenaan op ‘Request rollout to staging’
  4. Je aanvraag wordt automatisch bij ons onder de aandacht gebracht.
  5. Wij toetsen of het technisch ontwerp past bij het reeds goedgekeurde functioneel ontwerp.

Let op: Als wij het technisch ontwerp goedkeuren staat het daarna vast. Kom je er bij het testen met de klant achter dat je toch een endpoint (of veld) vergeten bent? Dan zul je een nieuwe versie aan moeten maken, het functioneel ontwerp aan moeten vullen, goedkeuring afwachten, het missende endpoint toevoegen en nogmaals goedkeuring afwachten.

Vanwege het generieke karakter van de koppelingen is deze goedkeuring alleen nodig bij de eerste keer dat je (een versie van) een koppeling naar staging wil brengen.

Een klant aansluiten

Als je koppeling eenmaal door ons is goedgekeurd om op staging gebruikt te worden, kun je klanten aan gaan sluiten. Om je koppeling toegang te laten krijgen tot de staging-omgeving van een klant doorloop je de volgende stappen:

  1. Maak een nieuwe .csr-file, vraag hiervoor de klant naar de klantcode voor zijn staging-omgeving.
  2. Log in op onze Topdesk-omgeving.
  3. Klik op Certificaat aanvragen of verlengen.
  4. Klik op Ons API: Nieuw certificaat aanvragen (goedgekeurde koppeling).
  5. Vul het formulier in en voeg je .csr-file toe.
  6. Wij controleren bij de gedeelde klant of zij akkoord gaan met dit verzoek voordat we het certificaat ondertekenen.

Hoe je een .csr maakt en aan welke eisen die moet voldoen lees je bij CSR Requirements

Let op: Wanneer een nieuw certificaat voor het eerst gebruikt wordt, wordt het automatisch gekoppeld aan de meest recente versie van je koppeling. Maak je daarna een nieuwe versie (bijvoorbeeld omdat je een endpoint was vergeten aan te vragen of omdat je doorontwikkelt aan de koppeling) dan worden bestaande certificaten niet automatisch overgezet naar deze nieuwe versie. Omdat een nieuwe versie doorgaans uitgebreidere toegang betekent doen we dit overzetten alleen met toestemming van de klant.

Productie

Goedkeuring van de koppeling aanvragen

Is de klant tevreden over de koppeling op de staging-omgeving? Dan kun je ons vragen je koppeling goed te keuren voor gebruik op productie. Hiervoor doorloop je de volgende stappen:

  1. Log in op het Ons API Dashboard
  2. Navigeer naar de koppeling die je aan het ontwikkelen bent
  3. Klik rechts bovenaan op ‘Request rollout to production’
  4. Je aanvraag wordt automatisch bij ons onder de aandacht gebracht.
  5. Wij controleren of de aangevraagde endpoints getest zijn en niet teveel foutmeldingen veroorzaken. Vervolgens keuren we de koppeling goed.

Een klant aansluiten

Is de koppeling goedgekeurd voor gebruik op productie? Dan kun je klanten aan gaan sluiten. Hiervoor doorloop je dezelfde stappen als bij het aansluiten van een klant op staging, alleen gebruik je nu de code van de productie-omgeving van de klant.

Belangrijk: Onze certificaten zijn standaard 1 jaar geldig. Zet alvast een herinnering in je agenda om 1 maand voor de verloopdatum van het certificaat een nieuw certificaat aan te vragen. Het is jouw verantwoordelijkheid te zorgen dat dit tijdig gebeurt. We versturen geen herinneringen.