| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Denne siden er STENGT fra offentligheten til den er klar |
| Table of Contents | ||
|---|---|---|
|
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
Når er nye endepunkter tilgjengelige?
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
...
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:
Summary
For some time, we have been transitioning away from our old technical platform. We have completed step 1 of our transition (Q3 2024), and we are now preparing for the next phase. Now, even more API endpoints will change URLs and require our new authentication (OAuth 2.0).
| Note |
|---|
End of Life is set to be: 31.01.2025 |
Affected APIs
Digital Distribution System (current URLs:
api.dds.boknett.no/*,idp.dds.boknett.no/*)Old endpoints will be turned off 01.02.2025
Order API (
currentlycurrent URL:
api.order.boknett.no)
Utgivere og distributører
- 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)
Old endpoints will be turned off 01.02.2025
What do I need to do?
...
General
Change the authentication to Authentication Service (for selected services)
Each service has it’s own
audienceneeded when fetching token
Change the URL for each API
No need for the previously required
Date-header
Response-headers are considered to be case-insensitive
I.e. don’t only look for
Location, the header might be calledlocation
If you are getting
413errors try to reducepagesizein the call, we will have a period with reduced payload-capabilities (both request and response)
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, see Use of Audience | |
|---|---|
dds |
|
ddsbokskya |
|
bokskyaorders |
|
ordersreporting |
|
Test Production -vs- productionsTest/stage
Login/auth for prod → Remove
.stageAudience for prod → Remove.stage→auth.bokbasen.io-vs-auth.stage.bokbasen.ioAudience →
api.bokbasen.io-vs-api.stage.bokbasen.ioAPI-endpoints for prod → Remove
.stage
...
→
api.bokbasen.io-vs-api.stage.bokbasen.io
New 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
New endpoint URL (test-environment)
metadata
POST
POST
GET
GET
Auth | API | Method | New endpoint URL (test-enviroment) | ||||||
|---|---|---|---|---|---|---|---|---|---|
metadata |
|
| |||||||
| |||||||||
dds |
|
| |||||||
|
| ||||||||
|
| ||||||||
|
| ||||||||
bokskya |
|
| |||||||
|
| ||||||||
orders |
|
|
| ||||||
|
| ||||||||
|
| ||||||||
|
|
Endpoints for Publishers & Distributors
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.
reporting |
|
|
|
|
(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
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.