Technische informatie per release (blog).
Deze documentatie is bijgewerkt t/m de laatste release.
Klik hier voor de laatste wijzigingen.
A) SOAP Webservices
1. Projectwebservice
SOAP 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 Niki wordt gebruikt als bronsysteem voor het beheer van projectgegevens en woningen.
De gegevens uit Niki kunnen dan overgenomen worden in het backend systeem. - Projectgegevens (met name de beschikbaarheid van woningen) realtime
tonen op een projectwebsite.
projectservice_handleiding.pdf
1.1 PHP projectservice client
Voor de projectservice is een client geschreven in PHP. Deze client bevat een aantal voorbeelden hoe de projectservice aangesproken kan worden.
handleiding projectservice phpclient
2. Interesse webservice
SOAP Webservice om in Niki ingevulde interesseformulieren uit te lezen.
Interesseformulieren worden niet alleen ingevoerd in Niki, maar ook via content sites en projectwebsites die zijn aangesloten middels bovenstaande projectservice.
B) REST API
1. Niki API
De Niki API maakt projectgegevens beschikbaar in JSON formaat.
2. OAuth voorbeeld in PHP
Een voorbeeld geschreven in PHP hoe middels OAuth een API token aan te vragen.
oauth.zip (standard OAuth PHP client)
Een tweede voorbeeld geschreven in PHP maar dit voorbeeld gebruikt een andere OAuth client API (zie ook http://www.phpclasses.org/package/7700-PHP-Authorize-and-access-APIs-using-OAuth.html)
C) Projectinvoer middels XML
Als project en woninggegevens reeds zijn opgenomen in een backend systeem, dan is het mogelijk dit systeem te koppelen aan de Niki database. Deze geautomatiseerde koppeling voorkomt dat gegevens op meerdere plaatsen beheerd moeten worden. Deze webservice gebruikt geen SOAP maar een eigen XML formaat.
communiceren_met_niki.pdf
lnp-schema-3.24.xsd
upload-voorbeelden.zip
Certificaten
1. Niki ROOT certificaat
Met dit 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.
D) XML Schema’s en voorbeelden
Dit 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
subscription-3.3.xsd
interesse-voorbeelden.zip
E) Content afname
Het is mogelijk om een Niki 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 Stichting LNP een content afname heeft aangemaakt.
content_afname.pdf
voorbeeld_website.zip
F) Database (ter referentie)
1. Database tabellen
Beschrijving van alle Niki database tabellen, velden en onderlinge relaties.
2. Objecten en relaties
Database objecten (Hibernate) en onderlinge relaties
