melsk-r / HC-BRK-bevragen-issues

0 stars 0 forks source link

ETO endpoints kunnen verwarring scheppen voor Prod endpoint #30

Open melsk-r opened 2 months ago

melsk-r commented 2 months ago

Originally created by KayodeBakker (https://github.com/VNG-Realisatie/Haal-Centraal-BRK-bevragen/issues/915):

Op dit moment in de 'Getting Started' wordt aangegeven dat de ETO twee endpoints kent, namelijk esd-eto-apikey (API Key only) en esd-eto (API Key + PKIO). Pas veel later in dit document staat de instructies voor productie welke alleen maar de esd-eto kent. Dit kan voor nieuwe afnemers een verwarrende probleem zijn als ze initieel alleen hebben gefocust op de testomgeving. Pas wanneer ze besluiten om naar productie te gaan, lopen ze wellicht tegen de issue aan dat ze opeens een PKIO certificaat nodig gaan hebben als de ETO koppeling alleen API Key was.

Ook bij de aanvraag lijkt geen referentie aan een PKIO worden gegeven waardoor de afnemer onwetend blijft.

Mijn voorstel zou zijn om alleen esd-eto ter beschikking te stellen (wellicht niet wenselijk omdat het niet laag drempelig genoeg is) of heel goed duidelijk maken dat productie beide API Key als PKIO vereist. Hierdoor is de afnemer vroeg op de hoogte en is het geen nare verrassing net vooraf aan productie.

melsk-r commented 2 months ago

This comment originally might have been created by someone else.

ik denk dat een zeer toegankelijke testomgeving wel toegevoegde waarde heeft, dus uitzetten van esd-eto-apikey ben ik niet voor. Maar het is wel een goed idee om vanaf het begin (bovenaan in de getting started) en bij het benoemen van de testomgevingen erop te wijzen dat voor productie een PKIO certificaat nodig is.

melsk-r commented 2 months ago

This comment originally might have been created by someone else.

Ik heb dit met Kayo besproken, en wij kwamen uit op dezelfde oplossing als jij @fsamwel. Ik pak dat op!