CS:Metadata Aanbieden

Uit Kennisnet Developers Documentatie
Versie door Muskee01 (overleg | bijdragen) op 27 mrt 2020 om 09:10 (uitzondering mogelijkheid niet adverteren)
Ga naar: navigatie, zoeken

Catalogus Service-symbol.png Catalogus Service: Metadata Aanbieden

Een partij kan standaard metadata aanbieden volgens de ECK-DT standaard.

Aanleveren catalogusinformatie op basis van de ECK DT standaard

Aansluitingsproces

Ondersteunde versies van de standaard

Lees meer over welke ECK-DC standaardversie we ondersteunen.
Momenteel kunnen wij ECK-DT CatalogService versies 2.1.1 en 2.2 harvesten. We gaan binnenkort ondersteuning bieden voor versies 2.2 en 2.3.

Harvester

Wij harvesten door middel van een WSDL definitie.
Er hoeft slechts één WSDL te worden gemaakt voor alle records.

We hebben een template, waarbij alleen de {{SERVICE_ENDPOINT_URI}} vervangen moet worden met de eigen SOAP endpoint locatie:

<soap:address location="{{SERVICE_ENDPOINT_URI}}"/>

Voor elke versie van de standaard moet een afzonderlijk eindpunt worden gemaakt.

template
Versie 2.2 https://wsdl.kennisnet.nl/eck/ECK-DT2-CatalogService-v2.2.wsdl
Versie 2.3 https://wsdl.kennisnet.nl/eck/ECK-DT2-CatalogService-v2.3.wsdl

SOAP endpoint

Via een SOAP endpoint worden alle records aangeboden volgens de specificaties van de standaard. Lees meer Standaarden:ECK-DT#SOAP

Metadata

In versie 2.3 van de ECK-DT standaard zijn de velden PriceVATHigh en PriceVATLow vervangen door de container Prices waarin meerdere bedragen opgenomen kunnen worden.
Elke Prices container moet één Currency element en ten minste één Price container bevatten indien IsCatalogItem veld de waarde “TRUE” heeft.
Het kan optioneel een Consumerprice element bevatten.

Elke Price container moet de volgende elementen bevatten:

  • Amount: De prijs in centen ( excl. BTW) en
  • VAT: Het BTW percentage .

Op deze manier kunnen ook belastingvrije producten worden toegevoegd.
Lees meer Standaarden:ECK-DT/CatalogService#Entry

Transport

De ECK-DT standaard en Catalogus Service Harvester ondersteunen incrementele harvesting via het ReadCatalog Since Vetgedrukte tekstargument.
De implementatie hiervan door de server is niet verplicht maar vanuit ons als harvestende partij wel aanbevolen.
Via incrementele harvesting kunnen nieuwe records worden aangeboden maar ook updates op reeds gestuurde records. Alle nieuwe records of wijzigingen worden doorgevoerd omdat Catalogus Service Harvester zal ze periodiek bij de bron endpoint ophalen. In geval van een update dient de volledige laatste versie een record te worden gestuurd.
Wij zullen, met behulp van de firstEntry en Amount velden, entries gepagineerd bij de bron endpoint opvragen. Standaarden:ECK-DT/CatalogService#Transport

Validatie

Catalogus Service Harvester kunt alleen maar data harvesten die valide is conform de geleverde XSD's. Standaarden:ECK-DT#Documentatie
Een gratis software https://www.soapui.org/ kan worden gebruikt om het WSDL / SOAP-eindpunt te valideren. Standaarden:SOAP
Valideer de uitvoer voordat het harvestverzoek ingediend wordt.

Harvestverzoek

Een harvestverzoek kan worden ingediend via onze servicedesk.
Er moet een openbare WSDL-locatie worden meegedeeld.
Optioneel kunnen zowel een OrganisationId als een wachtwoord worden gegeven. Standaarden:ECK-DT#Request<
We zullen alle records die we op die locatie harvesten via de WSDL valideren tegen het xsd-schema.
Als alle gegevens correct zijn, regelen we de aansluiting met Catalogus Service Harvester.

Aanleveren catalogusinformatie op basis van een CSV

We hebben het voor de gespecialiseerde uitgevers mogelijk gemaakt om op basis van CSV relatief eenvoudig catalogusinformatie in te dienen.

  • Het gaat in principe om een relatief klein aantal records die lange tijd ongewijzigd blijven.
  • Of een uitgever in aanmerking komt voor een dergelijke uitzondering, moet worden besproken met onze relatiemanagers.

Conversie

Een gespecialiseerde uitgever hoeft geen ECK-DT Catalogusservice webservice te bouwen, maar genereert een statische versie 2.2 XML uitvoer op basis van een CSV export van de catalogusinformatie. Voor dit proces hebben we een conversie applicatie gebouwd waarmee aanbieders dit zelf kunnen doen.

Proces

Voordat het gegenereerde XML ECK-DT Catalogusservice bestand beschikbaar is in ons Koppelpunt, moet deze eerst door ons worden gekoppeld. Het proces hiervoor werkt als volgt:

  • Een verzoek kan worden ingediend via onze servicedesk, waarbij het gemaakte XML bestand wordt toegevoegd.
  • Indien het een nieuwe koppeling betreft (ipv nieuwe gegevensversie), expliciet de relevante contactgegevens van de inhoudelijk/technisch verantwoordelijke meegeven.
  • Als alle gegevens correct zijn, regelen we de aansluiting met het Koppelpunt via onze harvester.