This page describes API endpoint for customers with partner models e.g. subscription model with revenue share or other models where you have access to download books from DDS without executing transactions first. All of these APIs require special commercial agreements with Bokbasen and special access rights. If you are building a standard sale-by-item book store you can safely ignore this page.
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/rvuHTTP/1.1 204 No Content |