Broker

Voor het uitwisselen van gegevens binnen het Zorgeloos Vastgoed afsprakenstelsel zal een RESTful -API ter beschikking komen. Dit document beschrijft de strategie waarmee de communicatie op een robuuste manier in de vorm van consistente en uniforme API, aan de keten wordt aangeboden.

Basis principes

De volgende basisprincipes zijn gevolgd bij het uitwerken van dit API-ontwerp:

• Maakt gebruik van web API-standaarden (RESTful)

• Is gebruiksvriendelijk voor ontwikkelaars en kan via de browser en dus online verkend worden. Is ontwikkelvriendelijk en sluit aan op de standaarden waarmee de ontwikkelaars gewend zijn te werken. Denk aan open-source softwareframework zoals Swagger, Postman, Insomnia.

• Is gebruiksvriendelijk voor business (legacy processen). Volgt W3C-standaard (JSON, (RDF) XML voorlopig) en is eenvoudig, intuïtief en consistent in gebruik waardoor het gebruik niet alleen gemakkelijk is maar ook aangenaam;

• Is voldoende flexibel om verschillende gebruiksscenario’s te ondersteunen. Faciliteert maatwerk mogelijkheid (toekomst e.g. SPARQL en GraphQL queries)

• Is efficiënt. Dit is in evenwicht met de voorgaande eisen denk aan (HATEOAS) loading

Interface

Onderstaand document beschrijft de standaard HDN-API waarop de communicatie binnen de Zorgeloos Vastgoed-keten gebaseerd zal worden. Deze zal aangepast worden conform het afsprakenstelsel Zorgeloos Vastgoed.