Versions Compared

Old Version 5

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

Saved on

compared with

New Version 6

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

Saved on

Key

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

...

Table of Contents
stylenone

Bestemme oss for språk.

F.eks. norsk til ledelse, engelsk til teknisk guides.

Helst: unngå å måtte duplisere tekst på begge språk.

Oppsummert

TODO En kort tekst for ledelse CEO/CTO

Datoer for utfasing

Oppsummert

Vi har i lengre tid skrevet oss ut av en gammel platform for metadata. Dagens løsning har en absolutt sluttdato som gjør at vi må skru av gamle tjenester i mai 2024. Ifm. denne moderniseringen bytter vi også løsning for pålogging, og går over til OAuth 2.0 standarden for både API-klienter og sluttbrukere.

Noen tjenester vil slutte å fungere (metadata), mens andre vil man kunne bruke som før (DDS, Bokskya, Ordre).

Men for å slippe å forholde seg til ulike påloggingsløsninger og API-generasjoner, så anbefaler vi at man skriver om all API-bruk til disse nye endepunktene.

Datoer for utfasing

Note

Utfasingsdato er nært forestående: 21.05.2024

  • Forhandlere:

    • Onix Export (prod) ikke lenger mulig å nå med gamle URLer: 21.05.2024

    • Object Export (prod) ikke lenger mulig å nå med gamle URLer: 21.05.2024

  • Forlag og distributører:

    • Onix Import (prod) ikke lenger mulig å nå med gamle URLer: 21.05.2024

    • Object Import (prod) ikke lenger mulig å nå med gamle URLer: 21.05.2024

...

  • Nye URLer i test, tilgjengelig fra 20.03.2024

    • Vi sender ut påloggingsinformasjon fortløpende fra denne dato

  • Nye URLer i prod, tilgjengelig fra 22.03.2024

    • Vi sender ut påloggingsinformasjon fortløpende fra denne dato

Berørte APIer

Info

Vi anbefaler å bytte alle APIer, men det er metadata (Onix og Object) som haster

Forhandlere

  • (warning) Må bytte:

    • Onix Export API (current URLs: api.boknett.no/metadata/export/onix/*)

    • Object Export API (current URLs: api.boknett.no/metadata/export/object/*)

  • Anbefaler å bytte:

    • Digital Distribution System (current URLs: api.dds.boknett.no/*, idp.dds.boknett.no/*)

    • Order API (currently: api.order.boknett.no)

Utgivere og distributører

  • (warning) Må bytte:

    • Onix Import API (currently: api.boknett.no/metadata/import/onix/*)

    • Object Import API (currently: api.boknett.no/metadata/import/object/*)

...

Technical Guide (in english)

What do I need to do?

Note

Some old API-endpoints will be turned of in May - implementing those are high priority

General

Audience-values

...

Audiences

The APIs are divided into several audiences (groups). Each API needs an access-token for the corresponding audience. So be sure to use the appropriate audience when fetching the token or you will get 403.

Audience-value to use with Auth (test-environment)

metadata

https://api.stage.bokbasen.io/metadata/

dds

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

bokskya

https://api.stage.bokbasen.io/bokskya/

orders

https://api.stage.bokbasen.io/orders/

...

Test -vs- productions

  • Login/auth for prod → Remove .stage

  • Audience for prod → Remove .stage

  • API-endpoints for prod → Remove .stage

Retailers

  • Onix Export ONIX

    • Use new token i Authorization-header, with given audience

    • Change base URL

...

Endpoints

Each API has gotten a new URL. Here you can see a overview of the new URLs as well as the corresponding audience to use.

Auth
Audience

API

Method Test-URL

New endpoint URL (test-enviroment)

metadata

(warning) ONIX (warning)

GET

https://api.stage.bokbasen.io/metadata/export/onix/v1

(warning) Objects (warning)

GET

(Object Export - TBA)

dds

Inventory

GET

https://api.stage.bokbasen.io/dds/inventory/v2

https://api.stage.bokbasen.io/dds/inventory/v2/{isbn}

Orders and reporting

POST

https://api.stage.bokbasen.io/dds/order/v1

Bokbasen distributes binaries to the end user

POST

https://api.stage.bokbasen.io/dds/order/subscription/v1

Content download

GET

GET

GET

GET

https://api.stage.bokbasen.io/dds/content/v1/{fulfillmentId}

https://api.stage.bokbasen.io/dds/content/v1/raw/{resourceId}

https://api.stage.bokbasen.io/dds/content/v1/library/{resourceId}

https://api.stage.bokbasen.io/dds/content/v1/{resourceId}/sample

bokskya

Bookshelf / OPDS

GET

https://api.stage.bokbasen.io/bokskya/content/v1/{id}

IDM

POST

GET

GET

https://api.stage.bokbasen.io/bokskya/account/v1

https://api.stage.bokbasen.io/bokskya/account/v1/{id}

https://api.stage.bokbasen.io/bokskya/account/v1/{email}

orders

Send Order

POST

https://api.stage.bokbasen.io/orders/v1

Update order line

POST

https://api.stage.bokbasen.io/orders/v1/{id}/update

Update order line status

POST

https://api.stage.bokbasen.io/orders/v1/{id}/lines/{lineId}

Get Order data

GET

GET

GET

https://api.stage.bokbasen.io/orders/v1

https://api.stage.bokbasen.io/orders/v1/{id}

https://api.stage.bokbasen.io/orders/v1/{id}/editx

Publishers & Distributors

Stage-configuration

Auth
Audience

API

Method

Test-URL

metadata

(warning) Import Service (warning)

POST

POST

GET

GET

https://api.stage.bokbasen.io/metadata/import/onix/v1

(Object Import - TBA)

https://api.stage.bokbasen.io/metadata/import/onix/v1/status/{id}

https://api.stage.bokbasen.io/metadata/import/onix/v1/status/all

orders

Get Order data

GET

GET

GET

https://api.stage.bokbasen.io/orders/v1

https://api.stage.bokbasen.io/orders/v1/{id}

https://api.stage.bokbasen.io/orders/v1/{id}/editx

How can I test?

When you have gotten test-credentials (clientId + clientSecret) from Bokbasen.