Skillnad mellan versioner av "API"

Från Temperatur.nu
Hoppa till navigeringHoppa till sök
Rad 4: Rad 4:
  
 
Data returneras i XML-format
 
Data returneras i XML-format
 +
 +
==Support==
 +
För support på API-funktionen, använd [http://www.temperatur.nu/forum/forslag-feedback/diskusionstrad-for-api-funktionen-t1373.html Forumet på www.temperatur.nu].
  
 
==Kort beskrivning==
 
==Kort beskrivning==

Versionen från 4 maj 2010 kl. 09.43

Det finns ett enkelt API för att hämta senaste temperaturerna från temperatur.nu.

Aktuell API-version 1.0. Observera att formatet för version 1.0 ännu ej är helt fastställt - mindre ändringar kan komma att ske.

Data returneras i XML-format

Support

För support på API-funktionen, använd Forumet på www.temperatur.nu.

Kort beskrivning

APIet är tänkt att användas av de som skapar extern mjukvara, tex applikationer för Iphone och Android. Målet är att APIet skall vara lättförståeligt och lätt att använda - feedback från användarna är av stor vikt för att kunna utveckla APIet!

Var finns APIet?

Den senaste versionen av APIet hittar du på www.temperatur.nu/api/tnu.php För att använda en specifik version kan du använda www.temperatur.nu/api/tnu_{version}.php, ex www.temperatur.nu/api_1.0.php för version 1.0. Inga garantier ges för att olika versioner av APIet är kompatibla.

Parametrar

Parameter Beskrivning Kan ej användas med Introducerad i API-version
p Anger för vilka orter data skall returneras - kommaseparerad lista lat, lon, num 1.0
simple Minimal output, returnerar endast temperatur, Name, shortname verbose 1.0
verbose Returnerar alla fält för orten, se beskrivning nedan simple 1.0
coordinates Visar koordinaterna för valda orter. Kan användas tillsammans med simple för att kunna positionera orter på en karta. verbose 1.0
lat Används tillsammans med lon och ev num. När dessa parametrar används returneras de num närmaste orterna, närmaste orten först. p 1.0
lon Används tillsammans med lat och ev num. När dessa parametrar används returneras de num närmaste orterna, närmaste orten först.. p 1.0
num Används tillsammans med lon och lon. Anger hur många orter som skall returneras. Standard är 1 och max är 5. p 1.0

Beskrivning av returnerade fält

Fält Beskrivning parameter som visar parameter som döljer Visas som standard Introducerad i API-version
<title> Mätpunktens namn på temperatur.nu X 1.0
<id> Mätpunktens id på temperatur.nu. Kan använads med parametern "p" för att hämta endast denna mätpunkts information simple X 1.0
<temp> Mätpunktens senaste temperatur. X 1.0
<lat> Mätpunktens latitud coordinates, verbose 1.0
<lon> Mätpunktens longitud coordinates, verbose 1.0
<lastUpdate> Tidpunkt då informationen senast uppdaterades på temperatur.nu verbose 1.0
<kommun> I vilken kommun ligger mätpunkten. verbose 1.0
<lan> I vilket län ligger mätpunkten. verbose 1.0
<url> Url till mätpunktens temperatur och grafer på www.temperatur.nu verbose 1.0
<dist> Hur långt från de givna koordinaterna ligger mätpunkten. Enheten är kilometer lat & lon simple 1.0

Exempel

Så här kan resultatet från en förfrågan på http://www.temperatur.nu/api/tnu_1.0.php?p=linkoping&verbose se ut:

<?xml version='1.0' encoding='iso-8859-1'?>
<rss version="2.0">
        <channel>
        <title>Temperatur.nu API 1.0</title>
        <link>http://wiki.temperatur.nu/index.php/Api</link>
<item>
        <title>Linköping/Centrum</title>
        <id>linkoping</id>
        <temp>10,1</temp>
        <lat>58.414297</lat>
        <lon>15.628788</lon>
        <lastUpdate>2010-05-04 09:29:14</lastUpdate>
        <kommun>Linköping</kommun>
        <lan>Östergötlands län</lan>
        <url>http://www.temperatur.nu/linkoping.html</url>
</item>
        </channel>
</rss>

Så här kan resultatet från en förfrågan på http://www.temperatur.nu/api/tnu.php?lat=58.376761&lon=15.562916&num=3 se ut:

<?xml version='1.0' encoding='iso-8859-1'?>
<rss version="2.0">
        <channel>
        <title>Temperatur.nu API 1.0</title>
        <link>http://wiki.temperatur.nu/index.php/Api</link> 
 <item>
        <title>Linköping/Jägarvallen</title>
        <id>jagarvallen</id>
        <temp>11,4</temp>
        <dist>2.5</dist>
</item>
<item>
        <title>Linköping/Ryd</title>
        <id>ryd</id>
        <temp>10,2</temp>
        <dist>3.8</dist>
</item>
<item>
        <title>Linköping/Gottfridsberg</title>
        <id>gottfridsberg</id>
        <temp>11,3</temp>
        <dist>4.7</dist>
</item>
</channel>
</rss>



Villkor

  • APIet får ej accessas oftare än var femte minut från klienterna. Om detta villkor bryts kan det IP-nummer som överskrider tidsgränsen tillfälligt att blockeras.
  • Det måste mycket tydligt framgå att temperaturerna kommer från temperatur.nu.
  • Där så är möjligt skall temperaturerna vara länkar till temperatur.nu.
  • Temperatur.nus logotype skall finnas i applikationen, gärna så den tydligt syns när programmet används. Om detta ej är möjligt kan logotypen placeras där inställningar för applikationen görs.
  • APIet får ej användas för att automatiskt samla in och lagra data längre än 24h.