| Table of Contents |
|---|
CB Media Interface Description
Revisions
...
Version
...
| Date | Description |
|---|---|
| Added extra information authorisation: “Basic ”||"Base64 encoding of username and password joined by a single colon : " |
| Media Order B2C: Yaml file version 1.3.0 Changelog version 1.2.0 to version 1.3.0:
MediaShipment: Yaml file version 1.0.0 version 1.1.0 Changelog version 1.0.0 to version 1.1.0:
|
| Authentication notify services, CB supports:
|
| Test and order simulation added |
| Add Tag matrix for Green and Standard option |
| Update yaml file MediaOrderNotify v.1.0.2.yaml |
| Update generic error messages |
| Align with updated order notifications |
| Update yaml file MediaOrderB2C v1.2.0.yaml |
| Update MediaOrderB2C version Correct resource for notifyOrder and notityShipment |
| Update yaml versions |
| Add volume limits and error messages; Correct typo in process flow diagrams |
| Add flows and sequence diagrams |
| Add operations |
| Initial document |
Introduction
This document contains a description of the standard interfaces for implementation of data exchange with CB via webservices.
| The entire set for the standard data exchange with CB consists of the following documents and files: | ||||||||||||
| The mapping from file based to webservice based messages | ||||||||||||
| Tag matrix for Green and Standard option | ||||||||||||
CB has two options for submitting e-commerce orders:
| ||||||||||||
| yaml definition files | An OpenAPI Specification file (yaml) for each resource | |||||||||||
MediaOrderB2C v1.2.0.yamlhttps://services.cb.nl/rest/api/v1/mediaorderb2c/swagger.yaml Contains PUT (cancel), GET (status) and POST (place order) | ||||||||||||
MediaOrderNotify v1.0.2.yamlMediaShipment v1.0.0 | ||||||||||||
Overview webservices
This chapter gives an overview of the available interaction patterns for data exchange with CB. The figure below gives an high level overview of the CB system landscape and the available webservice operations.
...
| Webservice name: | MediaOrderNotify |
| Definition: | MediaOrderNotify.yaml |
| Resource: | Notifications |
| Operations provided by you: | |
| notifyOrder | CB calls your webservice to inform you about status updates of an order |
| Authentication mode | CB supports:
|
MediaShipment
| Webservice name: | MediaShipment |
| Definition: | MediaShipment.yaml |
| Resource: | ShippingUnits |
| Operations provided by CB: | |
| getShippingUnit | Retrieve the shipment information for a shipping unit |
...
| Webservice name: | MediaShipmentNotify |
| Definition: | MediaShipmentNotify.yaml |
| Resource: | Notifications |
| Operations provided by you: | |
| notifyShipment | CB calls your webservice to inform you about a shipment for your order |
| Authentication mode | CB supports:
|
Process flows
This chapter contains the identified flows when using webservices to order physical books at CB. The most common and regular scenario is describes in the happy flow. In addition 7 frequent scenarios are described in alternative flows.
...
- Processed ShippingUnit is ready for shipping
| Include Page | ||||
|---|---|---|---|---|
|
Test environment
| Include Page | ||||
|---|---|---|---|---|
|
...