Navnelabarotoriets API er beskrevet i nedenstående tabel.
| Resource | URI | Method | Repræsentation | Status | Beskrivelse |
|---|---|---|---|---|---|
| Godkendte fornavne | /fornavne?køn={pige|dreng}&q={søgestreng} | GET | XML(default), JSON eller JSONP | 200, 405, 500 | Modtag liste over godkendte fornavne. '*' anvendes som wildcard tegn i søgestrengen. |
| Statistik på navn | /navne/{køn}/{navn} | GET | XML(default), JSON eller JSONP | 200, 404, 405, 500 | Modtag statistik om et navn. Navn kan enten være et fornavn eller et fornavn og efternavn adskilt med et blanktegn. |
| Fornavnets hitlister | /fornavne/{køn}/{fornavn}/hitlister | GET | XML(default), JSON eller JSONP | 200, 404, 405, 500 | Modtag oplysninger om hvilke år fornavnet optræder Navngivningens Top 50. |
| Antal navngivet med et givet fornavn pr. år | /fornavne/{køn}/{fornavn}/antal | GET | XML(default), JSON eller JSONP | 200, 404, 405, 500 | Modtag information om hvormange der pr. år bliver navngivet med et givet fornavn. |
Baseadresse: http://jordal.dk/navnelaboratoriet
Eksempler på brug af API'et kan du finde her
Hvis intet suffix angives returneres data default i xml. Det samme sker hvis suffixet .xml angives
Navnelabarotoriets ressourcer returneres default i xml. Hvis repræsentationen ønskes i JSON tilføjes url'en suffixet .json. JSON står for JavaScript Object Notation og er specielt velegnet i forbindelse med udvikling af JavaScript klienter, som f.eks. web sider. I stedet for /fornavne/dreng skrives /fornavne/dreng.json.
JSONP er et mekanisme til at omgå cross-domain kommunikationsproblemet i en browser: Hvis du fra JavaScript kode i en browser forsøger at forespørge på data fra et andet domæne, vil du få en sikkerhedsfejl. JSONP mekanismen går i korte træk ud på at dynamisk loader et scripttag i et html dokument, hvor src attributen udpeger de ønskede data. De ønskede data returneres, formateret som et JavaScript funktionskald med data som parameter. Mekanismen er lidt svært at beskrive uden at vise en del html og JavaScript kodestumper. Det er der ikke plads til her, men du kan læse en god beskrivelse her
Hvis du f.eks. vil have fat i oplysninger om godkendte pigenavne som starter med 'fre' fra din browserapplikation kan du bruge http://jordal.dk/navnelaboratoriet/fornavne/pige.json?q=fre*&callback=vispigenavne til at kalde vispigenavne funktionen i din JavaScript applikation med kommunens information formateret i JSON argument.