Skillnad mellan versioner av "API"

Från Temperatur.nu
Hoppa till navigeringHoppa till sök
Rad 18: Rad 18:
 
*Temperatur.nus [[Logotype|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.
 
*Temperatur.nus [[Logotype|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.
 
*APIet får ej användas för att automatiskt samla in och lagra data längre än 24h.
 +
*I de fall applikationen kommer att kosta pengar för användaren krävs särskild överenskommelse med temperatur.nu. Kontakta [mailto:in[email protected] [email protected]] för mer information.
  
 
==Kort beskrivning==
 
==Kort beskrivning==

Versionen från 28 juni 2010 kl. 08.13

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

Aktuell API-version 1.3.

Data returneras i XML-format

Support

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

Villkor

  • Skriver du ett kul program som använder detta API? Kontakta [email protected]!
  • APIet får ej accessas med samma förfrågan 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.
  • I de fall applikationen kommer att kosta pengar för användaren krävs särskild överenskommelse med temperatur.nu. Kontakta [email protected] för mer information.

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.2.php för version 1.2. Inga garantier ges för att olika versioner av APIet är kompatibla med varandra. Målsättningen är dock att APIerna skall vara bakåtkompatibla.

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
dc Anger om decimalkomma skall användas i stället för decimalpunkt i fälten <temperatur>, <lat>, <lon> och <dist>. 1.0
simple Minimal output, returnerar endast <title>, <id> och <temp> 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 utan att behöva hämta alla fält. verbose 1.0
lat Används tillsammans med lon och ev num. Det spelar inte någon roll om decimal- eller kommapunkt används. 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. Det spelar inte någon roll om decimal- eller kommapunkt används. 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
cli Skall användas för att identifiera vilken klient som hämtar data. Parametern är frivillig, men kommer att bli ett krav i framtiden. Ex "cli=tnu_widget" 1.1
graph Används för att generera en graf för upp till 5 orter specificerade med variabeln p. 1.2
span Specificerar för vilket tidsperspektiv grafer skall skapas. Giltiga värden är: 1day (standard), 1week, 1month, 1year. 1.2
x Specificerar hur bred grafen skall vara. Giltiga värden är 150-1000. 300 är standard. 1.2
y Specificerar hur hög grafen skall vara. Giltiga värden är 125-600. 200 är standard. 1.2

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ändas med parametern "p" för att hämta endast denna mätpunkts information simple X 1.0
<temp> Mätpunktens senaste temperatur. Om decimalkomma eller decimalpunkt skall användas styrs med parametern dc. X 1.0
<lat> Mätpunktens latitud i decimalt format. Om decimalkomma eller decimalpunkt skall användas styrs med parametern dc. coordinates, verbose 1.0
<lon> Mätpunktens longitud i decimalt format. Om decimalkomma eller decimalpunkt skall användas styrs med parametern dc. coordinates, verbose 1.0
<lastUpdate> Tidpunkt då informationen senast uppdaterades på temperatur.nu verbose 1.0
<kommun> Den kommun som mätpunkten ligger i. verbose 1.0
<lan> Det län som mätpunkten ligger i. 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 mätpunkten ligger. Enheten är kilometer. Om decimalkomma eller decimalpunkt skall användas styrs med parametern dc. lat & lon simple 1.0
<graph> Visar url till graph för orten. Observera att ny graf endast genereras när parametern graph används. Det går därför inte att lokalt cacha urlen i klienten. graph (x, y, span) 1.2

Exempel

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

<?xml version='1.0' encoding='iso-8859-1'?>
<rss version="2.0">
        <channel>
        <title>Temperatur.nu API 1.2</title>
        <link>http://wiki.temperatur.nu/index.php/Api</link>
        <item>
                <title>Linköping/Centrum</title>
                <id>linkoping</id>
                <temp>20.2</temp>
                <lat>58.414297</lat>
                <lon>15.628788</lon>
                <lastUpdate>2010-05-19 14:22:02</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_1.2.php?lat=58.376761&lon=15.562916&num=3&graph se ut:

<?xml version='1.0' encoding='iso-8859-1'?>
<rss version="2.0">
        <channel>
        <title>Temperatur.nu API 1.2</title>
        <link>http://wiki.temperatur.nu/index.php/Api</link>
        <item>
                <title>Linköping/Jägarvallen</title>
                <id>jagarvallen</id>
                <temp>18.2</temp>
                <dist>2.5</dist>
                <graph>http://www.temperatur.nu/cg/jagarvallen-1day-300-200.png</graph>
        </item>
        <item>
                <title>Linköping/Ryd</title>
                <id>ryd</id>
                <temp>19.2</temp>
                <dist>3.8</dist>
                <graph>http://www.temperatur.nu/cg/ryd-1day-300-200.png</graph>
        </item>
        <item>
                <title>Linköping/Skäggetorp</title>
                <id>skaggetorp</id>
                <temp>20.7</temp>
                <dist>5.2</dist>
                <graph>http://www.temperatur.nu/cg/skaggetorp-1day-300-200.png</graph>
        </item>
        </channel>
</rss>

Historik/ändringslogg

2010-05-04 - Version 1.0 Första releasen.

2010-05-13 - Version 1.1 Variabeln cli tillagd.

2010-05-19 - Version 1.2 Stöd för att hämta grafer

2010-06-09 - Version 1.3 Bugfix som fixar en bugg introducerad i 1.2 (det gick inte att hämta alla orter genom att skippa variabeln p).