Beställning och åtkomst
För att få tillgång till produkten behöver du göra en beställning. Du kan använda länken Beställ i menyn till höger.
- Basic Autentisering är en enkel autentiseringsmetod där användaren anger användarnamn och lösenord för att verifiera sin identitet och få åtkomst till en tjänst.
- OAuth2 är en nyckelbaserad autentisering där användaren med hjälp av API-portalen administrerar behörighetsgrupper och behörighetsnycklar för att tilldela åtkomst till tjänster. Läs mer om och gå till API-portalen på lantmateriet.se.
Observera: För att hitta API:et för produkten i API-Portalen söker du med namnet på API:et som är OGC-Features
Villkor och avgifter
Produkten är avgiftsfri och får användas enligt Creative Commons licens CC BY 4.0. Läs mer om villkoren på Creative Commons webbplats.
Tillgänglighet
Så här fungerar produkten
Produkten har två typer av frågor: hitta och hämta. Tjänsten har REST-gränssnitt och svaren levereras antingen i XML- eller i JSON-format. Detaljerad information om detta finns i den tekniska beskrivningen för Ortnamn Direkt där det även finns en gränssnittsdefinition med gällande XML- och JSON-schema.
Hitta
Frågan ställs genom att ange hela eller delar av ortnamnet som fritext. Svaret innehåller ortnamnsreferenser som sedan kan användas i funktionen hämta ortnamn.
Hämta
Information kan hämtas genom att ange; Id för ortnamn, punkt eller med komplex filtrering. Varje fråga ger ett detaljerat svar om ortnamnet, se informationsinnehåll.
Med Id för ortnamn kan ortnamn sökas fram. Sökning kan ske för flera identiteter samtidigt.
Med komplex filtrering kan man söka på hela eller delar av namnet. Man kan välja att lägga till sökning på språk, läns- och kommunkod eller namntyp. Med komplex filtrering kan man välja att ange en punkt för närmaste ortnamn. Närmast punkt kan kombineras på samma sätt som vid sökning på namn. Antalet i resultatet av sökningen kan begränsas av ett intervall (start- och slutindex). Maximalt antal objekt i en sökning är 400.
Tekniskt ramverk och standard
Tjänstegränssnitten är REST baserade där objekttyper i många fall är uppbyggda med hjälp av GML (Geography Markup Language) eller JSON (JavaScript Object Notation) för att beskriva dess geografiska egenskaper.
Tjänsterna är av karaktären 'fråga-svar' där konsumenten (användarens system) skickar ett tjänsteanrop med sökbegrepp eller urvalsparametrar och erhåller en lista med ett eller flera geografiska objekt som svar. För att snabbt komma igång och testa tjänsterna innan de är integrerade i ett eget system kan ett verktyg som exempelvis Postman som är ett verktyg för test av REST-baserade webservices användas.
Teknisk beskrivning
I den tekniska beskrivningen finns åtkomstpunkter, scheman med mera.
Läs mer i den tekniska beskrivningen.