Page tree
Skip to end of metadata
Go to start of metadata

Inleiding

Dit afspraken bericht voor digitale producten ( Digital Product Agreement(s) Customer Specific) in xml formaat, dient voor het kenbaar maken van de klantspecifieke 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.

Mutatiebestand

Het bericht wordt dagelijks in de ochtend klaargezet in de out map van het FTP account wat voor u is ingericht. De eerste keer dat dit bestand voor u wordt klaargezet zal dit een initieel bestand zijn en bevat het alle afspraken voor de, op dat moment door de uitgevers aan uw webshop beschikbaar gestelde, digitale producten. Vervolgens worden er dagelijks mutatiebestanden aangeboden met daarin opgenomen enkel de gewijzigde afspraken voor digitale producten. Zodra er iets is gewijzigd aan het digitale product zal het product, met de afspraken worden opgenomen, in het bestand.  Wijzigt er niets, dan zal het digitale product en de afspraken niet meer in het mutatiebestand staan. 

Om de webshop up-to-date te houden is het van belang dagelijks de mutatiebestanden te verwerken

Het is géén mutatiebericht 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 beschikaar

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..n

9789029273632

13-cijferig ISBN


Consumentenadviesprijs
RetailPrice

1..n





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

Valuta
Currency
1..nEURDe valuta code van de prijs


Kortingspercentage
DiscountPercentage

1..n

30.00

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


Mag bestellen indicator
AllowedToOrder

1..n

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..n

Y

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


Bookshelf indicator
Bookshelf

1..n

N

Indicator waarmee wordt aangegeven of het ISBN via het studentenplatform Bookshelf geleverd wordt


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>
                    <Bookshelf>N</Bookshelf>
             </Product>
             <Product>
                    <Ean>9789029825091</Ean>
                    <RetailPrice>
                           <Amount>8.99</Amount>
                           <Currency>EUR</Currency>
                    </RetailPrice>
                    <DiscountPercentage>30</DiscountPercentage>
                    <AllowedToOrder>Y</AllowedToOrder>
                    <Webshop>Y</Webshop>
                    <Bookshelf>N</Bookshelf>
             </Product>
       </Products>
</Message>

Algemene informatie FTP account

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 TLSv1, data channels zijn gelimiteerd tot poortrange 41000:42000. Om gebruik te maken van versleuteld ftp, dient uw ftp cliënt software dit wel te ondersteunen.

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

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

Een FTP account heeft de volgende kenmerken:

  • /Relatie id/in/       (map waar de orderbestanden, pdf en jpg bestanden geplaatst worden);
  • /Relatie id/out/     (map waar CB de bestanden voor u plaatst);
  • De home directory is /relatie id/;

Directories en subdirectories

Er mogen geen directories en subdirectories aangemaakt worden!

De naamgeving van een bestand bestaat uit twee delen, het gedeelte voor en na de punt;

  • de bestandsnaam, welke voor de “punt” geplaatst is (bestandsnaam.ext);
  • de extensie, welke na de “punt” geplaatst is.

Bestandsnaam

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. 

Parallelle inlogsessies voor hetzelfde bestand zijn niet toegestaan.

Bestanden die door u worden geplaatst in de map /in/ worden direct na binnenkomst door CB verplaatst en verder verwerkt. Bestanden mogen alleen geplaatst worden en daarna niet meer bewerkt, naam veranderen etc.. Van geplaatste orderberichten wordt automatisch een ontvangstbevestiging teruggeplaatst. De frequentie om in te loggen op de server mag niet vaker zijn dan 1 keer per 10 minuten. 

Bestanden die door u worden opgehaald (gedownload) van de FTP server uit de /out map, worden automatisch verwijderd door de FTP server. Bestanden die niet worden opgehaald, worden i.v.m. ruimtebesparing na enige tijd door het CB verwijderd.

Transfer modus

Voor de verbinding dient van commando PASV (passive mode) gebruik gemaakt te worden.

De transfer modus Binair/ASCII waarin bestanden worden geplaatst/ opgehaald is de volgende:

Binair: alle bestanden met de extensies ‘.epub’, ‘.jpg’, ‘.pdf’ en ‘.zip’

ASCII: alle overige extensies

Englisch version -  Data exchange via FTP

 Click here for the English version - Data exchange via FTP

Data files will be exchanged through the FTP(S) protocol. Encryption of the messages based on the protocol ftp(e)s (FTP over SSL) is mandatory. At this moment CB only supports TLSv1, data channels are limited to a port range 41000:42000. To use secure ftp, your ftp client software has to support it. Webservices and websites are secure as soon as confidential data is transferred.

For the digital communication, a FTP account is created on ftp1.boekhuis.

Via this account, files can be put on the ftp server by the customer and the desired files will be put by CB. Login credentials will be sent by CB to you after activating the FTP account.

A FTP account has the following characteristics:

  • /Relation Id/in/ (folder where orderfiles, pdf and jpg files can be put);
  • /Relation Id/out/ (folder where CB puts the files for you);
  • The home directory is /relation id/.

Directories en subdirectories

It is not allowed to create directories or subdirectories.

The naming of a file consists of two parts, the part before the dot and the part after the dot:

  • the file name which is placed before the dot (filename.ext);
  • the extension which is placed after the dot.

The file name may contain number 0-9, characters a-z (uppercase and/or lowercase) and the special characters “dot” (.), “dash” (-) and “underscore” (_). All other characters like spaces, trema, &, <, >, {, }, etc. are not allowed. 

For the extensions the use of uppercase is not allowed.

Files that are put in the /in/ folder are instantly moved and processed after receipt by CB. Files can only be put in the directory, it is not allowed to edit them or change the name etc. Automatically a receipt confirmation is placed. The frequency of login should not be more than once every 10 minutes.

Files that are downloaded by you from the /out/ folder on the FTP server are automatically deleted by the FTP server. Files that are not downloaded will be deleted by CB after some time for reasons of saving space.

Transfer mode

For the connection the command PASV (passive mode) should be used.

The transfer mode Binary/ASCII to be used for different kind of files put/downloaded is the following:

  • Binary: all files with extension ‘.epub’, ‘.jpg’, ‘.pdf’ or ‘.zip’
  • ASCII: all other extensions.




  • No labels