api.metodebok.no

Introduksjon

Api for metodebok er utviklet for å tilgjengeliggjøre innhold fra metodebok på andre plattformer, for eksempel journalsystemer, kvalitetssystemer eller via løsninger fra andre leverandører.

Api.metodebok.no er et REST API som aksepterer input ved json eller post, og returnerer data som json.

Base URL / endepunkt

Alle kall til API benytter endepunktet https://api.metodebok.no/v1. Merk at TLS er påkrevet, ukrypterte tilkoblinger med http er ikke tillat.

Tilgang / API tokens

Tilgang til API for metodebok er basert på api token, som opprettes og tildeles fra metodebok etter avtale. Api token kan være knyttet til foretak, slik at innhold fra metodebok som er godkjent eller på annen måte vektet vil få prioritert visning ved søk.

Bruk av API - headers

Alle kall til api må inkludere autorisering med api_token i headers:

Authorization: Bearer <api_token>

Dersom kall til api benytter json, må dette angis i headers:

Content-Type: application/json

Uten angivelse av format benytte standardverdi multipart/form-data.

Bruk av API - søk i innhold

Følgende endepunkt skal benyttes for å utføre søk:

https://api.metodebok.no/v1/search

{
  "phrase": "hodepine",
  "max_results": 50,
  "hf_approved": "no"
}

Feltene max_results og hf_approved er ikke obligatoriske. Maks antall returnerte treff er 100, standardverdi er 20. Hvis "hf_approved" er satt til "yes" vil kun treff i godkjente bøker for hf komme med i resultatet. Standardverdien er "no".

Api returnerer resultater formatert i json, med følgende eksempel på struktur. Feltet status er ok eller error. Feltet hits inneholder nummerert og sortert array.

(

    [status] => ok

    [hits] => Array

      (

                [0] => Array

                      (

                        [title] => Migrene og hodepine i svangerskapet

                        [book] => Fødselshjelp (NGF)

                        [link] => https://metodebok.no/emne/SCX7vN7h

                        [preview] => ...med sterk akutt hodepine utredes umiddelbart for alvorlige

                        svangerskapskomplikasjoner. (III) Vi anbefaler...

                        [hf_approved] => yes

                      )

                ...

          )

)

Brukerstøtte / support

Ved behov for brukerstøtte kan metodebok kontaktes.