Versions Compared

Old Version 7

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

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.

...

Info

 New Authentication & URLs introduced Q2 2024

URL

https://api.bokbasen.io/reporting/streaming/v1

Expand
titleLegacy

https://api.dds.boknett.no/usage/streaming

The token acquired from the Authentication Service (legacy).

Required header: Date 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/reporting/

JSON attributes

(for each item in items)

isbn

Required

ISBN of the book you are reporting numbers for, mandatory

periodFrom

Required

Start of the reporting period on the format yyyy-MM

periodTo

Required

End of the reporting period on the format yyyy-MM

productOwnerId

Required

Numeric ID of the publisher who owned the rights to the book during the reporting period

productOwnerName

Optional

Name of the publisher who owned the rights to the book during the reporting period

cost.totalCost

Required

The total cost that will be billed for this ISBN

cost.paidCost

Optional

Can be sent in addition to cost.totalCost if you separate between trial and subscription

cost.trialCost

consumption.total

Required

The total amount of books read

consumption.paid

Optional

Can be sent in addition to consumption.total if you separate between trial and subscription

consumption.trial

price.ppu

Optional

The price per book read (price per unit)

price.paidPpu

Optional

Can be sent in addition to price.ppu if you separate between trial and subscription

price.trialPpu

currency

Optional

The currency of the cost/ppu-fields

market

Optional

The market you are reporting for

Response headers

Response body

Empty on success

Returns

204

No success

40x

On errors

413

Status
colourGreen
titlenew

If payload is too big (6MB limit)

Example (curl)

Code Block
curl -v -X POST \
    -H "Authorization: Bearer <your-token>" \
    -H "Content-Type: application/json" \
    --data-binary "@sales_data.json" \
    https://api.bokbasen.io/reporting/streaming/v1

...