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
The get inventory service can give data on your entire catalogue or detailed information on one specific title.
| URL | https://api.dds.boknett.no/order/subscription | ||
| Method | POST | ||
| Request headers | Authorization | Required | The token acquired from the Authentication Service. Formated "Boknett TGT-...." |
| Date | Required | The timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT | |
| Accept | Required | application/json (We recommend all new implementations to use this header, XML support will be phased out in the future) | |
| Content-type | Required | application/json | |
| JSON attributes | orderid | Optional | Your store order ID, if not provided we will generate a random one |
| resid | Required | The product ID in DDS. Unique name for e-/audio books found in the inventory service. | |
| spd | Optional | Will default to 0 if not provided, only use this if you have that as a requirement in your contract with the publisher to provide price. | |
firstname | Optional* | First name of the person buying the book (Required for all books with SDRM) | |
| lastname | Optional* | First name of the person buying the book (Required for all books with SDRM) | |
| Response headers
| Location | ||
| Response body | Empty on success | ||
| Returns | 201 | Created | |
| 40x | On errors | ||
Revenue share 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.
| URL | https://api.dds.boknett.no/usage/subscription/rvu | ||
| Method | POST | ||
| Request headers | Authorization | Required | The token acquired from the Authentication Service. Formated "Boknett TGT-...." |
| Date | Required | The timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT | |
| Content-type | Required | application/json | |
| JSON attributes | resid | Required | The product ID in DDS. Unique name for e-/audio books found in the inventory service. |
| dateTime | Required | The date the product passed the agreed threshold, given in ISO-8601 format. YYYY-MM-DD | |
| Response body | Empty on success | ||
| Returns | 204 | Success | |
| 40x | On errors | ||
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
...
as a subscription service provider, you cannot access content based on a regular order. There are also some special requirements with regards to reporting. The API separates between two types of subscription services:
| Child pages (Children Display) |
|---|