PAP/API Lite

PAP/API Lite eller PAPILITE som det förkortas till, är ett oberoende och öppet REST API. API-tjänsten tillhandahåller alla Sveriges postnummer och postorter samt gator, men även postnummer och postorter för Danmark, Norge och Finland. Användare får kostnadsfri tillgång till aktuella uppgifter såsom postnummer och postorter för Sverige och uppgraderade användare får fullständig tillgång. I Sverige finns det över 16.000 postnummer, 1.740 postorter och ungefär 400.000 gator. Antalet postnummer förändras ständigt, nya tillkommer medan andra faller bort. PAPILITE innehåller bara inte uppgifter om postnummer, postorter och gator, utan även kommuner, län och GPS-koordinater för samtliga postnummer. Detta gäller även för Danmark, Norge och Finland, bortsett ifrån gator. Detta är alltså ett komplett, flexibelt och användbart API som sparar tid och pengar när aktuella och korrekta uppgifter är avgörande.

Bakgrund

PAPILITE är efterträdaren till föregångaren PAP/API, som är helt avsomnad sedan slutet av 2017. Detta API är en betydligt mer kraftfull version än av dess föregångare. Det är flera gånger bättre och snabbare. Skillnaden mellan dem bägge är ytterst små och därav är PAPILITE ett fullvärdigt komplement till föregångaren PAP/API.

Grundaren och utvecklaren av PAPILITE är Senior Fullstack-utvecklaren Nille med 15 års erfarenhet av front och back-end i varierande omfattning.

Komma igång

PAPILITE är öppet och fritt att använda, nu och för alltid. Det krävs dock registrering för att kunna använda. Gratisvarianten ger möjlighet till maximalt 1.000 anrop per månad och saknar tillgång till bland annat gator i Sverige samt uppgifter från Danmark, Norge och Finland. Om man vill ta del av tjänstens fulla potential kan man uppgradera till betalande användare. Välj paket efter behov. De första 1.000 anropen varje månad är alltid kostnadsfria. Du betalar därefter bara för det som du använder. Inga månadsavgifter eller bindningstid. Avsluta eller nedgradera när som helst.

I samband med registrering godkänner användare följande användarvillkor.

Användning

Anrop

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.

[Endast för uppgraderade användare] Anrop med ofullständiga postnummer är möjligt, dock minst tre siffror, ex. 114 eller 1143 (utan mellanslag eller andra tecken).

| Parameter | Beskrivning | Exempel | | --------- | ------------------------------------------------------------ | ------------------------------------------------------------ | | query | Fullständigt postnummer med fem siffror<br />[Ofullständiga postnummer med minimum tre siffror] | 11434, [1143] eller [114] (utan mellanslag eller andra tecken) | | format | Format på svaret | JSON eller XML | | apikey | API-nyckel som tillhandahålls vid registrering | f21a1127be93feae4efc13dbb7bc587627b22114 |

Exempel på anrop

https://api.papapi.se/lite/?query=11434&format=json&apikey=f21a1127be93feae4efc13dbb7bc587627b22114

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.

[Endast för uppgraderade användare] Anrop med mindre antal bokstäver. Det är möjligt med endast två bokstäver, istället för minimum fyra bokstäver.

| Parameter | Beskrivning | Exempel | | --------- | ------------------------------------------------------------ | ------------------------------------------ | | query | Fullständig eller ofullständig postort med minst fyra bokstäver<br />[Ofullständig postort med minimum två bokstäver] | Stockholm, Stoc eller St | | format | Format på svaret | JSON eller XML | | apikey | API-nyckel som tillhandahålls vid registrering | f21a1127be93feae4efc13dbb7bc587627b22114 |

Exempel på anrop

https://api.papapi.se/lite/?query=Stockholm&format=json&apikey=f21a1127be93feae4efc13dbb7bc587627b22114

Gata och postort [Endast för uppgraderade användare]

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.

| Parameter | Beskrivning | Exempel | | --------- | ------------------------------------------------------ | ------------------------------------------ | | query | Fullständigt gatunamn och postort | Birger Jarlsgatan|Stockholm | | format | Format på svaret | JSON eller XML | | apikey | API-nyckel som tillhandahålls vid registrering | f21a1127be93feae4efc13dbb7bc587627b22114 |

Exempel på anrop

https://api.papapi.se/lite/?query=Birger Jarlsgatan|Stockholm&format=json&apikey=f21a1127be93feae4efc13dbb7bc587627b22114

Latitud och longitud [Endast för uppgraderade användare]

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.

| Parameter | Beskrivning | Exempel | | --------- | ------------------------------------------------------ | ------------------------------------------ | | query | Fullständiga GPS-koordinater, dvs latitud och longitud | 59.329323,18.068581 | | format | Format på svaret | JSON eller XML | | apikey | API-nyckel som tillhandahålls vid registrering | f21a1127be93feae4efc13dbb7bc587627b22114 |

Exempel på anrop

https://api.papapi.se/lite/?query=59.329323,18.068581&format=json&apikey=f21a1127be93feae4efc13dbb7bc587627b22114

Nordiska länderna [Endast för uppgraderade användare]

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.

| Parameter | Beskrivning | Exempel | | --------- | ------------------------------------------------------ | ------------------------------------------ | | query | Enligt ovan, postnummer, postort och GPS-koordinater | 0010, Oslo eller 59.917100,10.727400 | | country | Landsförkortning | no | | format | Format på svaret | JSON eller XML | | apikey | API-nyckel som tillhandahålls vid registrering | f21a1127be93feae4efc13dbb7bc587627b22114 |

Exempel på anrop

https://api.papapi.se/lite/?query=0010&country=no&format=json&apikey=f21a1127be93feae4efc13dbb7bc587627b22114

Svar

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 |

Svarkoder 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 |

Anropskvot Custom HTTP-headers

Följande special HTTP-headers kan användas för överblick av anropskvot, antingen dagligen för uppgraderade användare eller måntligen för gratisanvändare.

| HTTP-header | Beskrivning | | ------------------ | --------------------------- | | UserDailyLimit | Max antal anrop per dag | | UserDailyQuota | Använda anrop för dagen | | UserDailyRemaining | Kvarvarande anrop för dagen | | UserMonthlyLimit | Max antal anrop per månad | | UserMonthlyQuota | Använda anrop för månaden | | *UserMonthlyRemaining