API-ordliste
Kort ordliste over API-begreper, som blant annet brukes i den tekniske dokumentasjonen vår.
| API | Definisjon fra Wikipedia: Et programmeringsgrensesnitt (API) er et datagrensesnitt som definerer samspillet mellom flere programvarekomponenter. Det definerer hvilke typer kall eller forespørsler som kan gjøres, hvordan de gjøres, hvilke dataformater som skal brukes, hvilke konvensjoner som skal følges, osv. |
| API-endepunkt | Et API-endepunkt tar imot forhåndsdefinerte inndata, utfører én operasjon og returnerer forhåndsdefinerte utdata. |
| API-skjema | Et API-skjema fungerer som en bruksanvisning for programmeringen. Det beskriver API-ets operasjoner og metoder, og hvordan man samhandler med det. Et godt definert API-skjema gjør det mulig for utviklere å lage maskingenerert API-dokumentasjon som kan leses av både mennesker og maskiner. Det gjør API-et enklere å finne og ta i bruk. |
| API-scoping | Vi bruker API-scoping til å styre kundetilgang, slik at ulike kunder og kundegrupper kan få tilgang til ulike sett med endepunkter. |
| API-nøkkel | En hemmelig nøkkel som gir tilgang til API-endepunktene. Du lager den i NorData-dashbordet og sender den med hver forespørsel, enten i headeren X-API-Key, som Authorization: Bearer <nøkkel> eller i query-parameteret api_key. Hold den hemmelig, som et passord. |