Waar?
Als er gebruik wordt gemaakt van de Basic of Core API dan kan je via je PratoFlex- omgeving gebruik maken van Swagger.
Meestal is dat https://<url-PratoFlex>/webservice/swagger/ui/index
Via Swagger vind je de nodige informatie bij de request- en response modellen van de endpoints.
Bij de endpoints en elementen kan er deprecated vermeld staan.
Wat betekent dit ?
Net zoals functionaliteit in PratoFlex zal ook de API aangepast moeten worden. In sommige gevallen hebben deze wijzigingen gevolgen naar dure onderhoudbaarheid en beperkingen van nieuwe functionaliteiten.
In deze gevallen kan het zijn dat we nieuwe endpoints en/of elementen ontwikkelen en/of verwijderen.
Deze endpoints en elementen zullen als deprecated worden gemarkeerd. Dit wil zeggen dat we:
- afraden om deze endpoints/elementen te gebruiken bij nieuwe ontwikkelingen;
- een alternatief voorzien als dat noodzakelijk is;
- de endpoints/elementen op termijn niet meer zullen supporteren.
- Alternatief: Het alternatief dat kan worden gebruikt of een aanduiding wanneer de nieuwe ontwikkeling wordt voorzien.
- Deprecated vanaf: De versie vanaf wanneer in Swagger de aanduiding is toegevoegd.
- Verwijderd vanaf: De versie vanaf wanneer de endpoints verwijderd zullen zijn en bijgevolg ook niet meer bruikbaar zijn.
Verwijderen ?
Verwijderen zal altijd in overleg gebeuren met de betrokken klanten en ontwikkelaars/gebruikers van de IntegrationAPI. We voorzien logging om te weten wie welke deprecated endpoints/elementen gebruiken en zullen hiervoor contact opnemen indien we plannen om dit te verwijderen.
Overzicht
Het overzicht van alle deprecated endpoints en elementen vind je op deze pagina.