Jaa someen

Osallistu!

Osoita ja jaa osaamisesi avoindata.net
palvelussa!.

Emme edellytä rekisteröitymistä.

Kokeile API:a konsolissa!

Avoindata.net - API

Käytä API:a kohtuudella, älä tee/koodaa sovelluksia, jotka aiheuttavat DoS tilanteen. DoS hyökkäyksillä hankaloitat koko palvelun (avoindata.net) käyttöä ja avoimen datan yhteisön toimintaa.

Jos teet sovelluksen joka käyttää API:a, meitä kiinnostaa tietää millaisen olet tehnyt. Kerro siis meille, yhteystiedot vasemmassa reunassa alhaalla ('Ylläpito').

Tietoja

Avoindata.net palvelu perustuu avoimen lähdekoodin projektiin Question2Answer.

Ylläpito

Projektin aikana on tehty Question2Answer käyttöliittymän suomennos, joka on kontribuoitu takaisin.

Dashboard on avoimen lähdekoodin projekti.

Vastuullinen ylläpitäjä:

Sponsorit

Avoindata.net dashboard on kehitetty Open Data Tampere Region projektissa.

API metodit ja niiden tila

  • Tekeillä
  • Testauksessa
  • Pois käytöstä
  • Käytössä

API:en kautta saat JSON formaatissa avoindata.net palvelun tietoja muun muassa kysymysten, vastausten, kategorioiden määristä. Alla olevien metodien kuvauksien otsikoissa on liikennevalot, jotka ilmaisevat aina kyseisen metodin tilaa. Jokaisen metodin kuvauksessa on esimerkki JSON palautettavasta datasta, kutsuttava URL sekä metodin tyyppi. API on toteutettu yksinkertaisella epiphany PHP-kirjastolla. API:n kehityksen alkutarina on kerrottu communities.ossoil.com sivulla .

Miten käytän API:a?

Onnistunut metodikutsu, jolle voidaan rakentaa sisältöä, palauttaa tyypillisesti:

  • Header tiedot (esim. "HTTP/1.1 200 OK")
  • Sisältö JSON muodossa (objektina)
  • Lisenssitiedot JSON muodossa (objektina)
Virhetilanteet ja niiden käsittely on kerrottu jäljempänä.

Esimerkit GitHubissa

Jokaiselle metodille pyritään tekemään muutama koodiesimerkki ja ne kootaan GitHubiin. Esimerkit tervetulleita! API:n kehittämiseen on osallistunut (käyttöesimerkkejä tuottamalla):

GET metodiin perustuvat

Tagit ja niiden kysymysmäärät

MetodiURLToiminto
GETapi.avoindata.net/tagsPalauttaa tagit ja niiden kysymysmäärät.

Parametrit: ei parametreja.

Alla esimerkki JSON, joka palautetaan:

{
   "tags":[
      {
         "title":"suomi",
         "count":3,
	 "wordid": 377
      },
      {
         "title":"tampere",
         "count":3,
	 "wordid": 25
      },
      {
         "title":"talous",
         "count":2,
	 "wordid": 1634
      }
]}
					

Koodiesimerkit löytyy GitHubista:

Yhden tagin 10 viimeisintä kysymystä (haku nimellä)

MetodiURLToiminto
GETapi.avoindata.net/tags/title/:tagin_nimiPalauttaa yhden tagin 10 kysymyksen tiedot.

Parametrit:

Alla esimerkki JSON, joka palautetaan:

  • Päivämäärä annetaan epoch muodossa. Esimerkiksi epoch: 1372069271 == ISO 8601: 2013-06-24T10:21:11Z
  • HUOM! Valinta nimellä saattaa epäonnistua, mikäli tagissa on skandinaavisia kirjaimia. Näissä tapauksissa voit käyttää ID valintaa (kts. alla). Tagien ID:t löytyy tagien listauksesta: api.avoindata.net/tags (Tagit ja niiden kysymysmäärät).
{ "tampere": [
    {"title":"Mistä saan matkakortin datamallin?",
     "id": 65,
     "viewcount": 205,
     "votes": 1,
     "updated": 1369291671,
     "answercount": 0,
     "url": "http://avoindata.net/65/mista-..."
    },
    {"title":"Pidetäänkö missään listaa?",
     "id": 31,
     "viewcount": 130,
     "votes": 0,
     "updated": 1367301902,
     "answercount": 2,
     "url": "http://avoindata.net/31/pidetaa..."
    }
]}					

Koodiesimerkit löytyy GitHubista:

Yhden tagin 10 viimeisintä kysymystä (haku ID:llä)

MetodiURLToiminto
GETapi.avoindata.net/tags/id/:idPalauttaa yhden tagin 10 kysymyksen tiedot.

Parametrit:

Alla esimerkki JSON, joka palautetaan:

  • Päivämäärä annetaan epoch muodossa. Esimerkiksi epoch: 1372069271 == ISO 8601: 2013-06-24T10:21:11Z
{ "questions": [
    {"title":"Pidetäänkö missään ...",
     "id": 31,
     "viewcount": 130,
     "votes": 0,
     "updated": 1367301902,
     "answercount": 2,
     "url": "http://avoindata.net/31/pidetaanko-missaan-..."
    },

    {"title":"Mistä saan matkakortin datamallin?",
     "id": 65,
     "viewcount": 205,
     "votes": 1,
     "updated": 1369291671,
     "answercount": 0,
     "url": "http://avoindata.net/65/mista-saan-..."}
]}					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Kategoriat ja niiden kysymysmäärät

MetodiURLToiminto
GETapi.avoindata.net/categoriesPalauttaa kategoriat, niiden kysymysmäärät ja ID:t.

Parametrit: ei parametreja.

Alla esimerkki JSON, joka palautetaan:

{
   "categories":[
    {"title": "QA alusta", "count":5,"catid": 1},
    {"title": "Kartat", "count":3,"catid": 2},
    {"title": "Liikenne", "count":2,"catid": 3},
    {"title": "Yhteisöt", "count":1,"catid": 7}
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Yhden kategorian kysymykset (haku ID:llä)

MetodiURLToiminto
GETapi.avoindata.net/categories/id/:idPalauttaa halutun kategorian kysymykset, max 100 kpl.

Parametrit:

Alla esimerkki JSON, joka palautetaan, jossa:

  • Päivämäärä annetaan epoch muodossa. Esimerkiksi epoch: 1372069271 == ISO 8601: 2013-06-24T10:21:11Z
  • HUOM! Kategorioiden ID:t löytyy kategorioiden listauksesta: api.avoindata.net/categoriess (Kategoriat ja niiden kysymysmäärät).
  • Uusin on ensimmäinen.
{ "questions": [
    {"postid":"44",
     "title": "Paljonko datan avaaminen on Suomessa...",
     "url": "http://avoindata.net/44/paljonko-datan...",
     "created": 1367739717,
     "tags" : ["NULL"]
     },
    {"postid":"74",
     "title": "Minkälainen muodollinen tai epämuodo...",
     "url": "http://avoindata.net/74/minkalainen-mu...",
     "created": 1369840235,
     "tags": ["helsinki","espoo","vantaa","tampere"]
     }
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Vastausmäärät päivän tarkkuudella

MetodiURLToiminto
GETapi.avoindata.net/answers/countPalauttaa vastausmäärät päivän tarkkuudella.

Parametrit: ei parametreja.

Alla esimerkki JSON, joka palautetaan, jossa:

  • Päivämäärä (date) annetaan [YYYY-MM-DD] formaatissa.
  • Alkaen aikaisimmasta ajankohdasta (vanhin ensin).
{ "answers": [
    {"count":"3",
     "date": 2013-04-12
     },
    {"count":"2",
     "date": 2013-04-13
     },
    {"count":"3",
     "date": 2013-04-14
     }
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Viimeisimmät 20 kysymystä

MetodiURLToiminto
GETapi.avoindata.net/questionsPalauttaa 20 viimeisintä kysymystä.

Parametrit: ei parametreja.

Alla esimerkki JSON, joka palautetaan, jossa:

  • Päivämäärä annetaan epoch muodossa. Esimerkiksi epoch: 1372069271 == ISO 8601: 2013-06-24T10:21:11Z
  • Uusin on ensin.
{ "questions": [
    {"title":"Kuinka työteliästä oli avata tal...",
     "id": 76,
     "userid": 2,
     "userhandle": "Jarkko Moilanen",
     "usergravatar": "http://avoindata.net/?q...",
     "viewcount": 127,
     "votes": 0,
     "created": 1369854791,
     "updated": 0,
     "answercount": 1,
     "url": "http://avoindata.net/76/kuinka-tyo...",
     "tags" : ["NULL"]},
    {"title":"Minkälainen muodollinen tai epämu...",
     "id": 74,
     "userid": 22,
     "userhandle": "jreini",
     "usergravatar": "http://avoindata.net/?q..",
     "viewcount": 91,
     "votes": 0,
     "created": 1369840235,
     "updated": 1369840759,
     "answercount": 1,
     "url": "http://avoindata.net/74/minkalaine...",
     "tags": ["helsinki","espoo","vantaa","tampere"]}
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Yhden kysymyksen kaikki tiedot

MetodiURLToiminto
GETapi.avoindata.net/questions/id/:idPalauttaa kysymyksen tiedot.

Parametrit:

Alla esimerkki JSON, joka palautetaan, jossa:

  • Päivämäärä annetaan epoch muodossa. Esimerkiksi epoch: 1372069271 == ISO 8601: 2013-06-24T10:21:11Z
  • Sisällön BBCode on muutettu html:ksi
{ "question": [
    {"title":"Koordinaattimuunnoksien ohjeita (ETRS-GK24-...",
     "id": 107,
     "content": "Onko olemassa ohjeita koordinaattimuun
      noksista (ETRS-GK24->ETRS89 lat/lon)? Tulee aina 
      esiin kun vie sijaintidataa sovelluksiin.",
     "viewcount": 45,
     "votes": 0,
     "created": 1378460904,
     "updated": 0,
     "answercount": 2,
     "url": "http://avoindata.net/107/koordinaattimuunnoks...",
     "tags": ["gis","kartta","muunnos","etrs","tampere"]}
],
 "answers": [
    {
    "postid":"108",
    "votes":"1",
    "content":"Jos kyseessä on vain pistemäisiä kohteita, 
     eli siis koordinaattipareja: Geodeettisen laitoksen 
     palvelu toimii oikein hyvin: 
     <a href='http://coordtrans.fgi.fi/' 
     title='http://coordtrans.fgi.fi/'>
     http://coordtrans.fgi.fi/</a>.
     ...",
    "created":1381052904
    },
    {
    "postid":"109",
    "votes":"1",
    "content":"Hei,\n\nJos kysymys koskee Tampereen 
     WMS/WFS-rajapinnalle tehtäviä kyselyitä, niin\n
     käytettäessä rajapinnan URL:ssa parametria 
     &srsName=EPSG:4326, saadaan muunnettua koordinaatit 
     lennossa suoraan WGS84-järjestelmään. ETRS-TM35FIN 
     järjestelmän EPSG-koodi on EPSG:3067.",
    "created":1381052904
    }
]
}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Kysymysmäärät päivän tarkkuudella

MetodiURLToiminto
GETapi.avoindata.net/questions/countPalauttaa kysymysmäärät päivän tarkkuudella.

Parametrit: ei parametreja.

Alla esimerkki JSON, joka palautetaan, jossa:

  • Päivämäärä (date) annetaan [YYYY-MM-DD] formaatissa.
{ "questions": [
    {"count":"1",
     "date": 2013-04-15
     },
    {"count":"1",
     "date": 2013-04-16
     },
    {"count": 0,
     "date": 2013-04-17
     }
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Yhden kuukauden kysymykset

MetodiURLToiminto
GEThttp://api.avoindata.net/questions/month/:nroPalauttaa käyttäjän kysymysten listauksen.

Parametrit:

Alla esimerkki JSON, joka palautetaan:

  • Päivämäärät (created ja updated) annetaan epoch muodossa.
  • Uusin on ensin.
  • Mikäli updated arvo on '0', ei kysymystä ole päivitetty.
{ "questions": [
    {"title":"Kuinka työteliästä oli avata tal...",
     "id": 76,
     "viewcount": 127,
     "votes": 0,
     "created": 1369854791,
     "updated": 0,
     "answercount": 1,
     "url": "http://avoindata.net/76/kuinka-tyo...",
     "tags" : ["NULL"]},
    {"title":"Minkälainen muodollinen tai epämu...",
     "id": 74,
     "viewcount": 91,
     "votes": 0,
     "created": 1369840235,
     "updated": 1369840759,
     "answercount": 1,
     "url": "http://avoindata.net/74/minkalaine...",
     "tags": ["helsinki","espoo","vantaa","tampere"]}
]}
	
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Tietyn vuoden yhden kuukauden kysymykset

MetodiURLToiminto
GEThttp://api.avoindata.net/questions/:year/:monthPalauttaa kuukauden kysymykset listana.

Parametrit:

Alla esimerkki JSON, joka palautetaan:

  • Päivämäärät (created ja updated) annetaan epoch muodossa.
  • Uusin on ensin.
  • Mikäli updated arvo on '0', ei kysymystä ole päivitetty.
{ "questions": [
    {"title":"Kuinka työteliästä oli avata tal...",
     "id": 76,
     "viewcount": 127,
     "votes": 0,
     "created": 1369854791,
     "updated": 0,
     "answercount": 1,
     "url": "http://avoindata.net/76/kuinka-tyo...",
     "tags" : ["NULL"]},
    {"title":"Minkälainen muodollinen tai epämu...",
     "id": 74,
     "viewcount": 91,
     "votes": 0,
     "created": 1369840235,
     "updated": 1369840759,
     "answercount": 1,
     "url": "http://avoindata.net/74/minkalaine...",
     "tags": ["helsinki","espoo","vantaa","tampere"]}
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Palvelun käyttäjät

MetodiURLToiminto
GETapi.avoindata.net/usersPalauttaa käyttäjälistauksen.

Parametrit: ei parametreja.

Palauttaa muun muassa käyttäjänimen (handle) ja ID:n (userid). ID:n avulla voit hakea kyseisen käyttäjän tilastoja (katso alla)

Alla esimerkki JSON, joka palautetaan:

  • Päivämäärät (created ja lastlogin) annetaan epoch muodossa.
  • pointscount = käyttäjän pistemäärä
  • questions_count = käyttäjän esittämien kysymysten määrä
  • answerscount = käyttäjän tarjoamien vastausten määrä
{ "users": [
    {"handle":"admin",
     "userid": 1,
     "pointscount": 370,
     "questions_count": 1,
     "answerscount": 4,
     "created": 1365754276,
     "lastlogin": 1368114275
     },
    {"handle":"Jarkko Moilanen",
     "userid": 2,
     "pointscount": 920,
     "questions_count": 2,
     "answerscount": 14,
     "created": 1365774101,
     "lastlogin": 1372842418
     }
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Yhden käyttäjän tiedot (Haku ID:llä)

MetodiURLToiminto
GETapi.avoindata.net/users/id/:idPalauttaa käyttäjän tiedot.

Parametrit:

Alla esimerkki JSON, joka palautetaan:

  • Päivämäärät (joined ja lastlogin) annetaan epoch muodossa.
  • profileurl = käyttäjän profiilin URL osoite avoindata.net palvelussa
  • points = käyttäjän pistemäärä
  • questionsasked = käyttäjän esittämien kysymysten määrä
  • questionsread = käyttäjän lukemien (avaamien) kysymysten määrä
  • answers_provided = käyttäjän tarjoamien vastausten määrä
  • questionids = käyttäjän esittämien kysymysten ID:t
  • HUOM! Kaikilla käyttäjillä ei ole kenttiä: about, location, name tai website.
{ "user": [
    {
     "about":"Community Shepherd, Open ...",
     "location":"Tampere, Finland",
     "name":"Jarkko Moilanen",
     "website":"http://www.hermia.fi/ope...",
     "handle": "Jarkko Moilanen",
     "profileurl": "http://avoindata.ne...",
     "joined": 1365774101,
     "lastlogin": 1374175919,
     "points": 920,
     "questionsread": 36,
     "questionsasked": 2,
     "answerprovided": 14,
     "questionids": ["65","86"]
    }
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Yhden käyttäjän (haku ID:llä) kysymykset

MetodiURLToiminto
GETapi.avoindata.net/users/id/:id/questionsPalauttaa käyttäjän kysymysten listauksen.

Parametrit:

Alla esimerkki JSON, joka palautetaan:

  • Päivämäärä (created) annetaan epoch muodossa.
  • votes = kysymyksen peukutusmäärä (netto).
  • created = koska kysymys esitetty (epoch).
  • answercount = vastausten määrä.
  • Uusin on ensin.
{ "questions": [
    {"title":"Koska saadaan suomenkielinen käyttöl...",
     "id": 25,
     "viewcount": 53,
     "votes": 3,
     "created": 1366089262,
     "answercount": 2,
     "url": "http://avoindata.net/25/koska-saadaan..."
    }
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Yhden käyttäjän (haku ID:llä) vastaukset

MetodiURLToiminto
GETapi.avoindata.net/users/id/:id/answersPalauttaa käyttäjän vastausten listauksen.

Parametrit:

Alla esimerkki JSON, joka palautetaan:

  • Päivämäärä (created) annetaan epoch muodossa.
  • id = vastauksen ID.
  • votes = vastauksen peukutusmäärä (netto).
  • created = koska vastaus esitetty (epoch).
  • viewcount = monestiko luettu.
  • parent_title = kysymyksen otsikko.
  • parent_id = kysymyksen id, johon vastaus liittyy.
  • parenturl = kysymyksen URL.
  • Uusin on ensin.
{ "answers": [
    {"parent_title":"Miten käyttäjäyhteisöltä...",
     "parent_id": 55,
     "id": 88,
     "viewcount": 0,
     "votes": 1,
     "created": 1371837535,
     "parenturl": "http://avoindata.net/55/m..."
    },
    {"parent_title":"Miten kysymyssivustolla ...",
     "parent_id": 62,
     "id": 63,
     "viewcount": 0,
     "votes": 0,
     "created": 1368162183,
     "parenturl": "http://avoindata.net/62/m..."
    }
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Käyttäjät ja kysymysmäärät

MetodiURLToiminto
GETapi.avoindata.net/users/questionsPalauttaa mm. käyttäjänimet ja kysymysmäärät.

Parametrit: ei parametreja.

Alla esimerkki JSON, joka palautetaan:

{ "users": [
    {"userid":11,
     "handle": "kola",
     "profileurl": "http://www.avoindata.net/use...",
     "questioncount": 12
    },
    {"userid":14,
     "handle": "apoikola",
     "profileurl": "http://www.avoindata.net/use...",
     "questioncount": 4
    }
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Käyttäjät ja vastausmäärät

MetodiURLToiminto
GETapi.avoindata.net/users/answersPalauttaa mm. käyttäjänimet ja vastausmäärät.

Parametrit: ei parametreja.

Alla esimerkki JSON, joka palautetaan:

{ "users": [
    {"userid":2,
     "handle": "Jarkko Moilanen",
     "profileurl": "http://www.avoindata.net/use...",
     "answercount": 14
    },
    {"userid":1,
     "handle": "admin",
     "profileurl": "http://www.avoindata.net/use...",
     "answercount": 4
    }
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

POST metodiin perustuvat

Etsi kysymysten joukosta hakusanalla

MetodiURLToiminto
POSTapi.avoindata.net/search/questionsPalauttaa kysymysten tiedot, joista hakusana löytyi.

Parametrit:

  • term, esim. term: tampere jyväskylä
  • Formin action = http://api.avoindata.net/search/questions

Alla esimerkki JSON, joka palautetaan:

{ "questions": [
    {"title":"Kuinka työteliästä oli avata tal...",
     "id": 76,
     "userid": 2,
     "userhandle": "Jarkko Moilanen",
     "useravatar": "http://avoindata.net/?qa=im...",
     "viewcount": 127,
     "votes": 0,
     "created": 1369854791,
     "updated": 0,
     "answercount": 1,
     "url": "http://avoindata.net/76/kuinka-tyo...",
     "tags" : ["NULL"]},
    {"title":"Minkälainen muodollinen tai epämu...",
     "id": 74,
     "userid": 4,
     "userhandle": "smoinen",
     "useravatar": "http://api.avoindata.net/ava...",
     "viewcount": 91,
     "votes": 0,
     "created": 1369840235,
     "updated": 1369840759,
     "answercount": 1,
     "url": "http://avoindata.net/74/minkalaine...",
     "tags": ["helsinki","espoo","vantaa","tampere"]}
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Esitä kysymys

MetodiURLToiminto
POSTapi.avoindata.net/questions/newEsitä uusi kysymys avoindata.net palvelussa.
HUOM! Käyttö vaatii domainin rekisteröimistä API:in. Ilmoita domainin nimi, josta tulet käyttämään metodia, niin annamme tarvittavat tiedot sähköpostitse. [lomake tähän]

Anna domainin nimi ja sähköpostiosoite, johon metodin käyttämiseen tarvittavat tiedot lähetetään. Säilytä viesti!

Anna doimainin nimi, niin saat tiedot ja ohjeet metodin käytöstä domainiin liitettyyn email- osoitteeseen (annettu rekisteröinnin yhteydessä).

Anna domainin nimi, joka poistetaan. Toimitamme ohjeet sähköpostitse rekisteröinnin yhteydessä antamaasi sähköpostiosoitteeseen.

Onnistuneet uuden kysymyksen esittämisen jälkeen palauttaa esitetyn kysymyksen tiedot JSON muodossa.

Parametrit:

  • otsikko, kysymyksen otsikko
  • kategoria, kysymyksen kategoria
  • kysymys, kysymyksen sisältö
  • tagit, kysymyksen tagit pilkulla eroteltuna
  • nimi, kysymyksen asettajan nimi (vapaaehtoinen)
  • email, kysymyksen asettajan email (vapaaehtoinen)
  • Formin action = http://api.avoindata.net/questions/new
  • Lisää Headerin: Access-Token: <saamasi avain>

Alla esimerkki JSON, joka palautetaan:

{ "question": [
   
]}
					

Koodiesimerkit löytyy GitHubista:

  • Php
  • Ruby
  • Python
  • Javascript
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...
  • Lisää esimerkkejä kaivataan...

Virheiden käsittely

Alla on tietoa API:n virheiden käsittelystä.

Olemattoman pyynnön kohdalla (ei metodia) palautetaan alla oleva JSON. Lisäksi API palauttaa headerin

"HTTP/1.1 404 Page Does Not Exist"

{ "errors": [
     {"code" : 404, 
     "reason" : "Page Does Not Exist", 
     "uri" : "http://api.avoindata.net/users/question/path" 
     }
]}		
					

Mikäli metodikutsu on validi, mutta palautettava setti on tyhjä, palautetaan alla oleva JSON, jossa "uri" sisältää annetun pyynnön URI:n. Lisäksi API palauttaa headerin

"HTTP/1.1 204 No Content"

{ "errors": [
     {"code" : 204, 
      "reason" : "No Content", 
      "uri" : "http://api.avoindata.net/categories/id/114" 
     }
]}	
					

Epäonnistuneen tietokantayhteyden kohdalla palautetaan alla oleva JSON, jossa "uri" sisältää annetun pyynnön URI:n, "code" virhekoodin ja "reason" virheen selityksen.

{ "errors": [
     {"code" : 2005, 
      "reason" : "Unknown MySQL server host '127..0.1' (3)", 
      "uri" : "http://api.avoindata.net/tags/id/25" 
     }
]}
					

Lisenssitiedot osana vastausta

API palauttaa onnistuneen pyynnön vastauksessa lisenssitiedot omana objektina. Pelkät lisenssitiedot palauttaa JSON muodossa http://api.avoindata.net/license

"rights": [{
    "contentLicense": "http://creativecommons.org/licenses/by-sa/3.0/",
    "dataLicense": "http://creativecommons.org/licenses/by-sa/3.0/",
    "copyrightNotice": "copyright avoindata.net 2013",
    "attributionText": "Sisältö on Suomen avoimen datan yhteisön tuottamaa.",
    "attributionURL": "http://avoindata.net"
 }]
}

Puuttuuko metodi? Löytyikö bugi?

Mikäli mielestäsi puuttuu jokin metodi, tee siitä 'bugiraportti' GitHubiin. Sitä ennen tarkista ettei joku ole jo ilmoittanut samasta asiasta.

Viimeisimmät avoimet ilmoitetut bugit

Listassa 20 viimeisintä avointa ilmoitettua bugia. Täydellinen listaus GitHubissa.

  • Ei uusia bugeja.

Viimeisimmät käsitellyt bugit

Listassa 20 viimeisintä käsiteltyä bugia. Täydellinen listaus GitHubissa.

API kyselyiden määrät päivän tarkkuudella

replace

Auta avoimuutta - jaa sosiaaliseen mediaan