Dokumenation

Introduktion

PAP/API Lite är ett öppet och oberoende REST API som är enkelt att komma igång med. Det innehåller flera användbara funktioner som gör det möjligt att kontrollera bland annat postnummer och postort i Sverige, Danmark, Norge och Finland.

= endast för uppgraderade användare


Anrop Request

Postnummer

Hämta data baserat på postnummer utförs enligt nedan. Endast fullständiga postnummer med fem siffror, ex. 11434 (utan mellanslag eller andra tecken) kommer att ge svar.

Anrop med ofullständiga postnummer är möjligt, dock minst tre siffror, ex. 114 eller 1143 (utan mellanslag eller andra tecken).

JSON

https://api.papapi.se/lite/?query=POSTNUMMER&format=json&apikey=DIN_APINYCKEL

XML

https://api.papapi.se/lite/?query=POSTNUMMER&format=xml&apikey=DIN_APINYCKEL

Postort

Hämta data baserat på postort utförs enligt nedan. Postortens namn kan vara ofullständigt men minst fyra bokstäver krävs för att ge svar.

Anrop med mindre antal bokstäver. Det är möjligt med endast två bokstäver, istället för minimum fyra bokstäver.

JSON

https://api.papapi.se/lite/?query=POSTORT&format=json&apikey=DIN_APINYCKEL

XML

https://api.papapi.se/lite/?query=POSTORT&format=xml&apikey=DIN_APINYCKEL

Gata och postort

Hämta data baserat på gata och postort utförs enligt nedan. Endast fullständigt gatunamn och postort, ex. Birger Jarlsgatan och Stockholm (separerat med "|") kommer att ge svar.

JSON

https://api.papapi.se/lite/?query=GATA|POSTORT&format=json&apikey=DIN_APINYCKEL

XML

https://api.papapi.se/lite/?query=GATA|POSTORT&format=xml&apikey=DIN_APINYCKEL

GPS-koordinater

Hämta data baserat på GPS-koordinater eller latitud och longitud utförs enligt nedan. Både latitud och longitud (ex. 59.329323,18.068581) krävs för att ge svar.

JSON

https://api.papapi.se/lite/?query=LATITUD,LONGITUD&format=json&apikey=DIN_APINYCKEL

XML

https://api.papapi.se/lite/?query=LATITUD,LONGITUD&format=xml&apikey=DIN_APINYCKEL

Nordiska länderna

Hämta data baserat på land utförs enligt nedan. Notera dock att det går inte att genomföra anrop med gata och postort, utan endast postnummer, postort och GPS-koordinater.

Använd se för Sverige, dk för Danmark, no för Norge och fi för Finland. Endast små bokstäver kan användas för landsförkortning. Notera dock att det inte är obligatoriskt att använda se för Sverige för det är standard.

JSON

https://api.papapi.se/lite/?query=ANROP&country=LAND&format=json&apikey=DIN_APINYCKEL

XML

https://api.papapi.se/lite/?query=ANROP&country=LAND&format=xml&apikey=DIN_APINYCKEL


Svar Response

Datan som returneras vid korrekt anrop innehåller följande postnummer (postal_code), postort (city), latitud (latitude), longitud (longitude), kommunkod (county_code), kommun (county), länskod (state_code), län (state), gator (streets), land (country), kartlänkar (maps), notering (notes), skapad (created) och uppdaterad (updated).

Anrop med Svar GRATIS Svar BETAL
Postnummer Endast en post Max 100 poster
Postort Max 100 poster Max 100 poster
Gata och postort Max 100 poster
GPS-koordinater Max 50 poster

Svarskoder HTTP-statuskoder

Anrop kan ge följande svarskoder som är standard HTTP-statuskoder.

HTTP-statuskod Beskrivning
200 — OK Korrekt anrop med svar
400 — BAD REQUEST Felaktigt anrop
401 — UNAUTHORIZED Felaktig API-nyckel
403 — FORBIDDEN Gräns nådd för anrop per dag eller spärrad API-nyckel
404 — NOT FOUND Korrekt anrop men utan svar

Daglig anropskvot Custom HTTP-headers

Följande special HTTP-headers kan användas för överblick av daglig anropskvot.

HTTP-header Beskrivning
UserDailyLimit Max antal anrop per dag
UserDailyQuota Använda anrop för dagen
UserDailyRemaining Kvarvarande anrop för dagen

Svar i JSON

{"api":{"name":"PAP-API Lite","url":"https://papilite.se","version":"X.X","updated":"ÅÅÅÅ-MM-DD TT:MM:SS","encoding":"UTF-8"},"results":[{"postal_code":"11434","city":"Stockholm","latitude":"59.3337496","longitude":"18.0757887","county_code":"0180","county":"Stockholm","state_code":"01","state":"Stockholm","streets":["Birger Jarlsgatan","Engelbrektsplan","Ingmar Bergmans Gata","Nybrogatan"],"country":"SE","maps":["https:\/\/www.google.com\/maps\/@59.3337496,18.0757887,17z","https:\/\/www.openstreetmap.org\/#map=17\/59.3337496\/18.0757887"],"note":"","created":"ÅÅÅÅ-MM-DD TT:MM:SS","updated":"ÅÅÅÅ-MM-DD TT:MM:SS"} [...] ]}

Notera att gator (streets) i exemplet ovan endast är tillgängligt för uppgraderade användare.

Svar i XML

<results>
  <api>
    <name>PAP/API Lite</name>
    <url>https://papilite.se</url>
    <version>X.X</version>
    <updated>ÅÅÅÅ-MM-DD TT:MM:SS</updated>
    <encoding>UTF-8</encoding>
  </api>
  <result>
    <postal_code>11434</postal_code>
    <city>Stockholm</city>
    <latitude>59.3337496</latitude>
    <longitude>18.0757887</longitude>
    <county_code>0180</county_code>
    <county>Stockholm</county>
    <state_code>01</state_code>
    <state>Stockholm</state>
    <streets>
      <street>Birger Jarlsgatan</street>
      <street>Engelbrektsplan</street>
      <street>Ingmar Bergmans Gata</street>
      <street>Nybrogatan</street>
    </streets>
    <country>SE</country>
    <maps>
      <map>https://www.google.com/maps/@59.3337496,18.0757887,17z</map>
      <map>https://www.openstreetmap.org/#map=17/59.3337496/18.0757887</map>
    </maps>
    <note></note>
    <created>ÅÅÅÅ-MM-DD TT:MM:SS</created>
    <updated>ÅÅÅÅ-MM-DD TT:MM:SS</updated>
  </result>
[...] </results>

Notera att gator (streets) i exemplet ovan endast är tillgängligt för uppgraderade användare.

Svar på anrop med GPS

Svar på anrop baserat på latitud och longitud ger samma svarsstruktur som vid övriga anrop (enligt ovan). Skillnaden är dock den att svaret innehåller 50 poster och sorterat efter kortast distans.