Ordnett API

Tilgang

Kontakt salg@ordnett.no for å inngå avtale om tilgang.

Autorisasjon

Spørringer mot API-et krever en API-nøkkel. Denne opprettes når avtale om bruk er inngått.

Autentiseringen foregår via HTTP Basic Auth. Bruk API-nøkkelen som brukernavnet i forespørselen. Du trenger ikke oppgi passord.

Eksempel på autorisasjon

$ curl -u api_nøkkelen_din: https://api.ordnett.no/api/v1/search
# Kolon etter API-nøkkelen hindrer curl i å be om passord

Statuskoder

Statuskoder brukt på api.ordnett.no

200 - OK Alt fungerte som forventet
400 - Bad request Forespørselen er ugyldig. Ved parameter-mangel
402 - Requeset Failed Forespørselen feilet
403 - Forbidden Ingen tilgang til ressursen
405 - Method Not Allowed Feil HTTP-metode
500 - Internal Server Error Feil på serveren

Endepunkter

https://api.ordnett.no/api/v1/correct-spelling

Få forslag til ord fra et feilstavet et

Parameter	Kreves	Gjentagbar	Standardverdi	Tillatte verdier	Kommentar
phrase	Obligatorisk	Ja			Søkeord
language	Valgfri	Nei	no	se /v1/languages	Språkkode

Eksempel på liste over søk etter grunnform

$ curl -u api_nøkkelen_din: https://api.ordnett.no/api/v1/correct-spelling?phrase=desverre
# Lister forslag på riktige ord

Respons på søk etter grunnform

{
"metadata": {
"provider": "Ordnett"
...
},
"searchdata": {
"phrase": "desverre"
"language": "no"
},
"corrected": [
"dessverre",
...
]
}

https://api.ordnett.no/api/v1/languages

Få en liste over tillatte søkespråk.

Eksempel på liste over tilgjengelige søkespråk

$ curl -u api_nøkkelen_din: https://api.ordnett.no/api/v1/languages
# Lister tillatte språk

Respons på liste over tilgjengelige søkespråk

{
"metadata": {
"provider": "Ordnett"
...
},
"languages": [
{
"name": "norwegian",
"languageCode": "no"
}
...
]
}

https://api.ordnett.no/api/v1/lemmas

Få grunnformen til et bøyd ord.

Parameter	Kreves	Gjentagbar	Standardverdi	Tillatte verdier	Kommentar
phrase	Obligatorisk	Ja			Søkeord
language	Valgfri	Nei	no	se /v1/languages	Språkkode

Eksempel på liste over søk etter grunnform

$ curl -u api_nøkkelen_din: https://api.ordnett.no/api/v1/lemmas?phrase=biler
# Lister tillatte språk

Respons på søk etter grunnform

{
"metadata": {
"provider": "Ordnett"
...
},
"searchdata": {
"phrase": "busser"
"language": "no"
},
"lemmas": [
"buss",
"busse"
]
}

https://api.ordnett.no/api/v1/publications

Få en liste over tillatte publikasjoner.

Eksempel på liste over tilgjengelige søkepublikasjoner

$ curl -u api_nøkkelen_din: https://api.ordnett.no/api/v1/publications
# Lister tillatte publikasjoner

Respons på liste over tilgjengelige søkepublikasjoner

{
"metadata": {
"provider": "Ordnett"
...
},
"publications": [
{
"id": 55,
"name": "Stor norsk ordbok",
"languageCode": "no"
}
...
]
}

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

Søk etter ett eller flere ord.

Parameter	Kreves	Gjentagbar	Standardverdi	Tillatte verdier	Kommentar
phrase	Obligatorisk	Ja			Søkeord
language	Valgfri	Nei	no	se /v1/languages	Språkkode
publication	Valgfri	Nei		se /v1/publications	Publikasjonsnummer
searchmode	Valgfri	Nei	headword	headword fulltext fulltext_with_lemmas fulltext_and	Søk på oppslagsord eller artikkeltekst
lemmasearch	Valgfri	Nei	false	true false	Søk på former av ord.
omitspellcheck	Valgfri	Nei	false	true false	Ikke bruk skrivefeilsjekk.
outputformat	Valgfri	Nei	json	xml json html	Artikkelsens visningsformat

Eksempler på søk

$ curl -u api_nøkkelen_din: https://api.ordnett.no/api/v1/search?phrase=bil&language=no
# Søk etter ett oppslagsord på norsk

$ curl -u api_nøkkelen_din: https://api.ordnett.no/api/v1/search?phrase=bil&phrase=buss
# Søk etter flere oppslagsord på standardspråk

$ curl -u api_nøkkelen_din: https://api.ordnett.no/api/v1/search?phrase=biler&lemmasearch=true
# Søk etter former av et oppslagsord

Respons på søk

{
"metadata": {
"provider": "Ordnett"
...
},
"searchdata": {
"phrases": [
"bil"
],
"language": "no"
...
},
"result": [
{
"phrase": "bil",
"correctedSpelling": "",
"found": 2,
"articles": [
...
]
}
]
}