Versions Compared

Old Version 1

changes.mady.by.user Lars-Erik Bjørk

Saved on

compared with

New Version Current

changes.mady.by.user Svein Are Grønsund

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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: Content download

Info

New Authentication & URLs introduced Q2 2024

URL

https://api.bokbasen.

...

URL

io/dds/order/subscription/v1

Expand
titleLegacy

https://api.dds.boknett.no/order/subscription

MethodPOSTRequest
headers

Authorization

Required

The token acquired from the Authentication Service.

Formated "

Example: Authorization: Boknett TGT-....

"

Required header: Date

Required

The timestamp the request was made. Must comply with RFC 1123 date formats. Example: Tue, 10 Jun 2014 16:23:42 GMT

Method

POST

Request
headers

Authorization

Required

The token acquired from the Authentication Service.

Audience: https://api.bokbasen.io/dds/

Example: Authorization: Bearer ...

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

https://api.bokbasen.io/dds

.boknett.no

/content/v1/{

fulfilmentId

fulfillmentId}

Response
body

Empty on success

Returns

201

Created

40x

On errors

Subscription reporting
Status
colourYellow
titleDeprecated

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.

Note

Note that this reporting service is replaced by Reporting from subscription services. New customers shall not use this. 

Expand
titleDetails

URL

https://api.dds.boknett.no/usage/subscription/rvu

Method

POST

Request
headers

Authorization

Required

The token acquired from the Authentication Service.

...

Example: Authorization: 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

Code Block
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

...



HTTP/1.1 204 No Content

...


Date: Fri, 07 Aug 2015 13:04:47 GMT