01. De webservice van de Connector
De Connector is geïmplementeerd als een RESTful web service. De gegevens (panden en relaties) worden in de vorm van XML berichten beschikbaar gesteld via de webservice. Deze gegevens worden opgehaald door het uitvoeren van een HTTP GET request. De Media Partner krijgt 'schone, valide' XML berichten terug; valide volgens vooraf gespecificeerde XSD schema's.
Om de Connector opdrachten te geven (bijvoorbeeld de opdracht om een Contract te accepteren) stuurt de Media Partner een XML bericht naar de webservice van de Connector. Dit laatste gebeurt door het XML bericht aan te leveren aan de Connector met een standaard HTTP POST actie.
Versie beheer
De implementatie van de Connector zal zich in de komende jaren evolueren. Verschillende Content Providers en Media Partners stellen in de toekomst mogelijk nieuwe eisen. Om hier aan te kunnen blijven voldoen zal de API van de Connector in de toekomst ongetwijfeld wijzigen. Nieuwe functies zullen worden toegevoegd en XML berichten zullen wijzigen. Om ervoor te zorgen dat er doorontwikkeld kan worden aan de Connector zonder dat alle Media Partners continu hun consumerende software aan moeten passen werkt de Connector met versies. En de Connector ondersteunt dus meerdere versies tegelijkertijd.
Versies zullen verschillen in API methods en de XML definities. Iedere versie kent dus zijn eigen XSD's. Een XML bericht uit versie X moet dus valide zijn met het bijbehorende XSD uit versie X. Een XML bericht uit versie X is dus niet per definitie valide volgens een XSD uit versie Y.
Zodra een versie de status 'Released' heeft zijn de API methods vastgelegd en zijn de XSD's niet meer wijzigbaar. Totdat de status van een versie 'Released' is zullen er nog wijzigingen mogelijk zijn. Bij een status 'Release Candidate' is dit erg onwaarschijnlijk; maar wel mogelijk. Bij een status 'Development' is dit juist heel waarschijnlijk. Als een XSD aangepast moet worden maar heeft de laatste versie van de API de status 'Released' dan zal er dus een nieuwe versie van de webservice komen.
Op dit moment zijn de volgende versies beschikbaar:
| Versie | Status | Url | Omschrijving |
|---|---|---|---|
| 1.0 | Retiring (30-09-2019) | https://api.wazzupsoftware.com/outputservice.svc/1/0/ | The first version of the Wazzup Real Estate Connector |
| 2.0 | Retiring (30-09-2019) | https://api.wazzupsoftware.com/outputservice.svc/2/0/ | The second iteration of the Wazzup Real Estate Connector |
| 9.0 | Retiring (30-09-2019) | https://api.wazzupsoftware.com/outputservice.svc/9/0/ | In this version specific Estonia and Commercial listing details are added |
| 16.0 | Released | https://api.wazzupsoftware.com/outputservice.svc/16/0/ | This is the most actual version of the Wazzup Real Estate Connector |
Locatie
De webservice voor Media Partners bevindt zich op de onderstaande locatie:
https://api.wazzupsoftware.com/outputservice.svc/X/Y/
Het aanroepen van de webservice zonder parameters zal leiden tot de foutmelding 'Endpoint not found'. In deze Wiki staat uitgelegd hoe je de webservice wel dient te gebruiken (RTFM 
).
Het versie nummer van de Connector staat vermeld in de URL van de webservice. https://api.wazzupsoftware.com/outputservice.svc/16/0/ betekent versie 16.0 (X = major version number = 16, Y = minor version number = 0).
Schema (XSD) bestanden
De Connector levert XML bestanden die altijd voldoen aan een vooraf gedefinieerd schema. Dit schema is in XSD bestanden vastgelegd. Iedere versie van de Connector kent zijn eigen schema, welke mogelijk afwijkt van het schema van een vorige versie.
Gebruik het juiste versienummer en token in de URL om toegang te krijgen tot het bestand. In onderstaande voorbeelden is token ABCDEFG als voorbeeld gebruikt.
XSD bestanden
XSD Media Contract Snapshot
XSD Real Estate Property Summary
XSD Real Estate Property
https://api.wazzupsoftware.com/InformationService.svc/16/0/ABCDEFG/files/?filename=RealEstateProperty.zip (Inclusief beschrijvingen en Schema weergave als HTML)
XSD Relation
https://api.wazzupsoftware.com/InformationService.svc/16/0/ABCDEFG/files/?filename=Relation.xsd