Deze documentatie is bijgewerkt t/m de laatste release.
Vragen? Neem contact op met support 070 30 04 370 of info@hetnieuwbouwplatform.nl.
Projectwebservice
SOAP WebservicesSOAP Webservice voor het uitlezen van projectgegevens en het verwerken van inschrijvingen.
De webservice kent twee belangrijke toepassingen:
- Koppelen aan backend systemen. Dit is handig als de database wordt gebruikt als bronsysteem voor het beheer van projectgegevens en woningen.
De gegevens uit de database kunnen dan overgenomen worden in het backend systeem. - Projectgegevens (met name de beschikbaarheid van woningen) realtime tonen op een projectwebsite.
PHP projectservice client
SOAP WebservicesVoor de projectservice is een client geschreven in PHP. Deze client bevat een aantal voorbeelden hoe de projectservice aangesproken kan worden.
Interesse webservice
SOAP WebservicesSOAP Webservice om ingevulde interesseformulieren uit te lezen. Alle interesseformulieren via content sites en projectwebsites die zijn aangesloten middels bovenstaande projectservice.
REST API
REST APIDe API maakt projectgegevens beschikbaar in JSON formaat.
OAuth voorbeeld in PHP
REST APIEen voorbeeld geschreven in PHP hoe middels OAuth een API token aan te vragen.
file_downloadOauth.zip (standard OAuth PHP client)
Een tweede voorbeeld geschreven in PHP maar dit voorbeeld gebruikt een andere OAuth client API (zie ook)
WordPress Plugin
REST APISteeds meer websites worden gemaakt in WordPress. Om te kunnen voldoen aan vragen vanuit de markt, is in opdracht van Het Nieuwbouw Platform is een WordPress plugin gebouwd waarmee webontwikkelaars nu nog eenvoudiger de data te kunnen ontsluiten in hun (project)sites. De plugin is te downloaden of rechtstreeks te installeren via de backend van de (project)site.
De plugin is “open source” geprogrammeerd, zodat anderen mee kunnen ontwikkelen aan de plugin. Fundament All Media zal beheerder blijven van de plugin en in opdracht van LNP kunnen er wijzigingen, verbeteringen en tips van anderen worden ingevoegd.
De plugin is geen uitgewerkte presentatielaag, het is niet zo dat men de plugin kan installeren en dat vervolgens automatisch het aanbod getoond wordt. De presentatielaag zal te allen tijde zelf nog moeten worden geïmplementeerd door de webbouwer. Wij hebben dat bewust zo geprogrammeerd, omdat elke ontwikkelaar z’n eigen ideeën heeft over hoe iets gepresenteerd moet worden. Wel worden er een aantal voorbeeldimplementaties weergegeven, maar styling moet dus zelf worden toegevoegd.
Projectinvoer middels XML
XMLAls project en woninggegevens reeds zijn opgenomen in een backend systeem, dan is het mogelijk dit systeem te koppelen aan de database. Deze geautomatiseerde koppeling voorkomt dat gegevens op meerdere plaatsen beheerd moeten worden. Deze webservice gebruikt geen SOAP maar een eigen XML formaat.
Het Nieuwbouw Platform certificaat
CertificatenMet dit zelf ondertekende certificaat zijn de SSL koppelingen op https://xml.niki.nl en https://acc.niki.nl ondertekend. Tevens worden alle client certificaten met dit certificaat ondertekend.
Voeg dit certificaat toe aan de locale omgeving als communiceren met een van bovenstaande URL’s beveiligingsproblemen geeft.
XML Schema’s en voorbeelden
XMLDit is het schema van de interesse XML
- Deze kan uitgelezen worden via de interesse webservice
- Deze kan ontvangen worden per email als het XML formaat is gekozen
Content afname
ContentHet is mogelijk om een zoeker te installeren op een eigen website. Deze zoeker zoekt dan binnen een vooraf gedefineerde lijst met projecten. Bijvoorbeeld alle projecten in een bepaalde gemeente. Dit werkt alleen als de Het Nieuwbouw Platform een content afname heeft aangemaakt.
Database (ter referentie)
Database1. Database tabellen
Beschrijving van alle database tabellen, velden en onderlinge relaties.
2. Objecten en relaties
Database objecten (Hibernate) en onderlinge relaties