Afspraken bericht voor digitale producten

Owned by Wilma Valkis - Temminck
Last updated: Feb 20, 2024Version comment
5 min read
Wijzigingshistorie
DatumOnderdeel Wijziging

 

Bookshelf indicator en xsd schema

Bookshelf indicator verwijderd. dipragmtcs.xsd vervangen

 

Bookshelf indicator

Met ingang van 01-07-2022 zal CB Bookshelf niet meer ondersteunen, daarmee verdwijnt element 'Bookshelf indicator' uit het bericht en zal met ingang 01-07-2022 niet meer worden opgenomen.

Inleiding

Dit afspraken bericht voor digitale producten ( Digital Product Agreement(s) Customer Specific) in xml formaat, dient voor het kenbaar maken van de klant specifieke afspraken omtrent digitale producten die uitgevers beschikbaar hebben gesteld aan de webshop, onder andere met de prijs en korting die van toepassing is voor de webshop. Het bericht dient tezamen met het ONIX 3.0 bericht met digitale producten gebruikt te worden. Waarbij het ONIX 3.0 bericht dient om de artikeldatabase up-to-date te houden en het Digital Product Agreement(s) Customer Specific bericht dient voor de bepaling welke titels er met welke consumentenprijs, opgenomen mogen worden in de webshop of het online studentenplatform Bookshelf en welke korting er voor de webshop van toepassing is.

Het is géén bericht om de digitale producten kenbaar te maken maar een bericht om de afspraken daaromtrent te communiceren.

Bestandsnaam

De bestandsnaam van de bestanden is als volgt:  <berichttype>_<relatie_id>_<verstuur datumtijd (DDMMYYYYHH24MISS)>.xml

Voorbeeld
dipragmtcs_7414440_28012020093202.xml

XSD schema

Het XSD schema voor download beschikbaar:   dipragmtcs.xsd

Gebruik van dit document


Tabel

Het bericht is opgedeeld in composites. Een composite is een groepering van verwante elementen. Een composite kan ook andere, onderliggende composites bevatten

Data elementen worden in de tabel in een witte rij weergegeven
Composites worden in een gearceerde rij weergegeven ten teken dat deze Composite op de volgende rijen verder wordt uitgewerkt in Data elementen en eventueel geneste Composites
ElementDe logische naam voor het Data element of de Composite
ElementNaam van het Data element of de Composite zoals gebruikt binnen het bericht
XML elementNaam en waarde van attribuut zoals gebruikt binnen het XML element
CardinaliteitHier wordt aangegeven of een Data element of Composite verplicht is en hoe vaak deze mag voorkomen
0..1Optioneel en mag maximaal één keer voorkomen
0..nOptioneel en mag maximaal meerdere keren voorkomen
1..1Verplicht en mag maximaal één keer voorkomen
1..nVerplicht en mag maximaal meerdere keren voorkomen
VoorbeeldBevat een voorbeeld waarde voor het Data element
ToelichtingBevat eventueel toelichtende opmerkingen bij het Data element of de Composite zoals bijvoorbeeld het formaat

Definitie bericht Digital Product Agreement(s) Customer Specific

ELEMENT

XML ELEMENT

CARDINALITEIT

VOORBEELD

TOELICHTING

Bericht

Message


xmlns = "http://www.cbonline.nl/xsd"


Header

Header

1..1




Bericht identificatienummer

MessageId

1..1

5652933



Verzenddatum en tijdstip 

SentDateTime

1..1

2020-01-07T15:55:23

notatie yyyy-mm-ddThh:mm:ss


Producten

Products

1..1




Product

Product

0..n


Indien er geen mutaties te berichten zijn bevat het bericht de composites Header en Products zonder composite Product


EAN/ISBN
Ean

1..1

9789029273632

13-cijferig ISBN


Consumentenadviesprijs
RetailPrice

1..1





Bedrag
Amount
1..112.99Door de uitgever aan de webshop afgegeven consumentenadviesprijs inclusief BTW. Decimalen scheidingsteken is een . (punt) 

Valuta
Currency
1..1EURDe valuta code van de prijs


Kortingspercentage
DiscountPercentage

1..1

30.00

Door de uitgever aan de webshop toegekend kortingspercentage. Decimalen scheidingsteken is een . (punt)


Mag bestellen indicator
AllowedToOrder

1..1

Y

Indicator waarmee wordt aangegeven of het ISBN door uitgever beschikbaar is gesteld aan de webshop en kan worden opgenomen in de webshop

Of een ISBN daadwerkelijk bestelt kan worden is afhankelijk van de volgende factoren:

  • AllowedToOrder heeft de waarde 'Y'
  • Het product is Verschenen (in ONIX 3.0 Product record heeft element ProductAvailability de waarde 21)
  • Een product wat door de uitgever op In Herdruk is gezet, is tijdelijk niet leverbaar en dient als zodanig op de webshop getoond te worden of dient verwijdert te worden uit de webshop.  De uitgever zal een titel op In Herdruk zetten als er een fout is geconstateerd in het e-book en er door de uitgever een nieuw e-book bestand geüpload dient te worden. (in ONIX30 Product record heeft element ProductAvailability waarde 34). Zodra er een nieuw e-book bestand beschikbaar is zal het product weer naar Verschenen worden gezet.
  • Een product wat door de uitgever wordt Teruggetrokken is niet leverbaar en dient als zodanig op de webshop getoond te worden of dient verwijdert te worden uit de webshop. (in ONIX30 Product record heeft element ProductAvailability waarde 40)

Webshop indicator
Webshop

1..1

Y

Indicator waarmee wordt aangegeven of van het ISBN een downloadlink geleverd wordt via de webshop 


Voorbeeld bericht voor testdoeleinden

Voor testdoeleinden is er een testbestand beschikbaar. Dit bestand bevat producten uit de CB testdatabase, het kan zijn dat deze producten niet in uw webshop bekend zijn.

dipragmtcs_7414440_30012020144752.xml


Voorbeeld van een Digital Product Agreement(S) Customer Specific bericht
<?xml version="1.0" encoding="UTF-8"?>
<Message xmlns="http://www.cbonline.nl/xsd">
       <Header>
             <MessageId>5652933</MessageId>
             <SentDateTime>2020-01-07T15:55:20</SentDateTime>
       </Header>
       <Products>
             <Product>
                    <Ean>9789029273632</Ean>
                    <RetailPrice>
                           <Amount>12.99</Amount>
                           <Currency>EUR</Currency>
                    </RetailPrice>
                    <DiscountPercentage>30.00</DiscountPercentage>
                    <AllowedToOrder>Y</AllowedToOrder>
                    <Webshop>Y</Webshop>
             </Product>
             <Product>
                    <Ean>9789029825091</Ean>
                    <RetailPrice>
                           <Amount>8.99</Amount>
                           <Currency>EUR</Currency>
                    </RetailPrice>
                    <DiscountPercentage>30</DiscountPercentage>
                    <AllowedToOrder>Y</AllowedToOrder>
                    <Webshop>Y</Webshop>
             </Product>
       </Products>
</Message>

Algemene informatie FTP account

 Click here for the English version

https://userguidescb.atlassian.net/wiki/x/BQCBBQ

Bestanden worden uitgewisseld middels het FTP(S) protocol. Versleuteling van de berichten op basis van het protocol ftp(e)s (FTP over SSL) is verplicht.
CB ondersteunt op dit moment enkel TLS 1.2, data channels zijn gelimiteerd tot poortrange 41000:42000. Om gebruik te maken van versleuteld ftp, dient de gebruikte ftp cliënt software dit wel te ondersteunen.

Webservices en websites zijn secure zodra daar vertrouwelijke gegevens over gaan.

CB stelt FTPs (SSL encryptie) 'FTP over TLS' verplicht maar staat 'Plain text FTP' nog toe. Met ingang van 1 maart 2025 is 'Plain text FTP' definitief niet meer toegestaan. 

Wanneer er gebruik gemaakt wordt van communicatie via FTP wordt er een ftp account op de ftp1.boekhuis.nl server van CB aangemaakt. Via dit account kunnen de bestanden voor CB geplaatst worden en zullen de gewenste bestanden door CB worden klaargezet. De inloggegevens worden toegestuurd na activeren van het account.

Kenmerken FTP account
/Relatie id/

Home directory
in/map  voor bestanden van Klant naar CB

Geplaatste bestanden worden door CB direct na binnenkomst verplaatst voor syntactische controle en verdere verwerking.  Na plaatsen van het bestand is het niet toegestaan om deze nog te bewerken . 

Van geplaatste bestanden wordt automatische een ontvangstbevestiging geplaatst in de out map

out/map voor bestanden van CB naar KlantBestanden die gedownload of geopend worden zullen automatisch van de ftp server verwijderd worden. Bestanden die niet worden opgehaald, zal CB na enige tijd verwijderen
Aanmaken van directories en sub-directories is niet toegestaan.
Naamgeving bestand bestaat uit 2 delen, gedeelte voor en na de 'punt'
voor de 'punt'bestandsnaam
na de 'punt' extensie
De bestandsnaam mag opgebouwd worden m.b.v. cijfers 0 t/m 9, de letters a t/m z (hoofdletters en/of kleine letters) en de speciale karakters “punt “ (.), dash (-) en underscore (_). Alle andere karakters zoals spatie, trema, &, <, >, {, } etc. zijn niet toegestaan. Voor de extensie is het gebruik van hoofdletters niet toegestaan. 
Connectie met ftp server - Transfer mode
Frequentie voor inloggen op de ftp server is maximaal 1 keer per 10 minuten. Aan het eind van iedere sessie dient er uitgelogd te worden.
Parallelle inlogsessies voor hetzelfde bestand zijn niet toegestaan.
Transfer modeVoor de verbinding dient gebruik gemaakt te worden van commando PASV (passive mode)
Binairalle bestanden met de extensies '.epub', '.jpg', '.pdf' en '.zip'
ASCIIalle overige extensies