When you are using DDS and a have a user that has subscription permissions you cannot use the normal /order POST to create orders. Then you use this version which has a few modifications and additional validations to use in order to get access to watermarked content for your subscription customers.
Place an order for a subscription service
Before downloading the book for a customer you make an order, and based on that order you can use get content to download the file.
...
Authorization
...
The token acquired from the Authentication Service.
Formated "Boknett TGT-...."
...
firstname
...
First name of the person buying the book (Required for all books with SDRM)
...
Location
...
https://api.dds.boknett.no/content/{fulfilmentId}
...
Subscription reporting
This service is only for customers with subscription model using the revenue share financial model. When passing the agreed threshold for reading (i.e. 10%) the subscription provider should send a call this usage API reporting which book the threshold was met for. This can either be done in real time or on a batch basis, but reporting should at a minimum be done daily.
...
Authorization
...
The token acquired from the Authentication Service.
Formated "Boknett TGT-...."
...
Example (curl)
Successful reporting on a book that has reached the reading threshold
curl -i-H "Content-Type: application/json" -H "Authorization: Boknett TGT-20025-OIgkKTofLlCJQasKhiuigfGQ7p0PueBCBvp0IFkN7TeQ0lrdFS-login.boknett.no" -H "Date: Fri, 07 Aug 2015 12:54:00 GMT" -d '{"resid":"fab4599e-eb2e-445a-a7f9-4af12c052dec","dateTime":"2015-10-21"}' https://api.dds.boknett.no/usage/subscription/rvu
...
In this scenario, the subscription service is responsible for delivering content to the end user. This puts an additional set of requirements on the service, especially with regards to information security. This is regulated in an own agreement (a partner agreement). The following section details on how the service gains access to the content.
Accessing the content
The subscription service needs to ingest content from Bokbasen, and prepare the content for distribution to end users. The inventory API, gives information about all e-/audio books available based on your user's access rights and permissions. The endpoint is implemented with a cursor functionality, making it easy to regularly fetch information about new (or revoked) content. The information from the inventory must be used in combination with information from the metadata API, to ensure that all constraints (embargo dates, sales restrictions, etc.) are met.
Each entry in the inventory has an identifier that uniquely identifies a resource, i.e. <id>urn:uuid:99496f82-84c5-4de7-9899-31603e26a355</id>. If there is an updated version of a resource (i.e.a producer has uploaded an updated version of an e-/audio book), the identifier will change. When downloading content for ingestion, this identifier must be used, as described in the section about partner models.
Reporting
The reporting functionality for subscription providers distributing files to the end user is currently under development. Some of the headlines are:
- Single point of reporting, Bokbasen will distribute reports to all relevant product owners.
- All data within a reporting period must be delivered simultaneously.
- If a product changes owner within a reporting period, the product must be reported twice (one time on each owner)