Velkommen til mitKBHs API dokumentationswiki

Her dokumenterer vi det REST baserede API som bliver stillet til rådighed af mitKBH.dk - brugernes guide til København.

Lettere simplificeret kan man sige, at vi gennem vores REST API stiller data fra mitKBH til rådighed så du kan bruge den i dine egne projekter. Dataen kan du hente på samme måde, som du henter en hjemmeside: Gennem en URL. I stedet for at skulle trække information ud fra vores uhåndterlige HTML kode, får du bare en omgang XML, der gerne skulle være lidt mere spiselig. Du kan læse mere om REST på Wikipedia.

Et hurtigt overblik over Wiki'en:

  • Services - En oversigt over de forskellige kald API'et tilbyder
    • StedInfo - Hent information, billeder og anmeldelser af et sted
    • StedSøgning - Søg efter steder der opfylder et eller flere kriterier
  • ApiKey - Fortæl os hvem du er, når du bruger API'et
  • FejlFormat - Formatet for den XML der returneres, hvis der opstår en fejl ved et kald
  • KendteFejl - Fejl og mærkværdigheder vi er (eller burde være) klar over
  • Versionering - Sådan versioneres vores API
  • OpdateringsLog - Her beskriver vi de ændringer der er lavet i de forskellige versioner
  • Licens - Sådan må du bruge API'et
  • Projekter - Folk der gør brug af mitKBH API'et.

mvh
mitKBH DevTeam
api(snabela)mitkbh.dk

Seneste ændringer

  • 24. februar 2009: Version 1.2 er online under 1.x, se version_1.2
  • 18. juli 2007: Version 1.1 er online under 1.x, se version_1.1
  • 18. juli 2007: Vi har droppet support for specifikke versioner - se Versionering for en uddybning
  • 16. juli 2007: Version 1.0 er online under 1, 1.x, og 1.0
  • 8. juni 2007: Et preview på version 1.0 bliver gjort tilgængelig under 1.x. Forvirret? Læs mere om vores vores Versionering

Online versioner

Versionsnavn Reel version Type
1 version 1.0 Stabil (Indeholder altid seneste stabile version)
1.x version 1.2 Beta (Indeholder seneste publicerede beta)

Forvirret? Læs mere om vores vores Versionering

Kom hurtigt i gang

mitKBH API'et tilbyder to services StedSøgning og StedInfo. Hvis du bare gerne vil i gang med at lege med API'et med det samme, så er her et par hurtige eksempler, der burde give dig en idé om, hvad det hele handler om.

Sted søgning

En liste med alle steder, der matcher søgekriteriet Collective kan tilgås gennem følgende URL: http://api.mitkbh.dk/1.x/nodes/?search=Collective

Det giver noget ligende:

<?xml version="1.0" encoding="utf-8"?>
<response status="ok">
  <nodesearchresult>
    <resultsreturned>3</resultsreturned>
    <resultsfound>3</resultsfound>
    <nodes>
      <node>
        <id>1646</id>
        <name>The Coffee Collective</name>
        <address>
          <street>Jægersborggade 10</street>
          <zipcode>2200</zipcode>
        </address>
        <position>
          <latitude>55.6920977601</latitude>
          <longitude>12.5449901526</longitude>
        </position>
        <phone>60407570</phone>
        <nodetypes>
          <nodetype id="2" primary="true">Cafeer</nodetype>
          <nodetype id="6">Take Away</nodetype>
          <nodetype id="10">Butikker</nodetype>
        </nodetypes>
        <rating>
          <score>5.5000</score>
          <votes>16</votes>
        </rating>
        <teaser>...utiast vil gerne tilslutte sig roserne til Coffee &lt;b&gt;Collective&lt;/b&gt;. Super lækker kaffe, sød betjening og f</teaser>
      </node>
      <!-- flere resultater -->
    </nodes>
  </nodesearchresult>
</response>

Sted info

Ud fra eksemplet kan vi se, at Caféen The Coffee Collective har id 1646. Vi kan kan hente al information om The Coffee Collective inklusiv alle anmeldelser og billeder af stedet gennem følgende URL: http://api.mitkbh.dk/1.x/nodes/1646.xml

Det giver noget lignende:

<response status="ok">
  <node>
    <id>1646</id>
    <name>The Coffee Collective</name>
    <address>
      <street>Jægersborggade 10</street>
      <zipcode>2200</zipcode>
    </address>
    <position>
      <latitude>55.6920977601</latitude>
      <longitude>12.5449901526</longitude>
    </position>
    <phone>60407570</phone>
    <link>http://www.mitkbh.dk/node.php?node=1646</link>
    <website>http://www.coffeecollective.dk/</website>
    <openinghours>Hverdage: 7:30 - 18:00, Weekend: 10:00 - 18:00</openinghours>
    <created day="25" month="02" year="2008" />
    <active>true</active>
    <nodetypes>
      <nodetype id="2" primary="true">Cafeer</nodetype>
      <nodetype id="6">Take Away</nodetype>
      <nodetype id="10">Butikker</nodetype>
    </nodetypes>
    <rating>
      <score>5.5000</score>
      <votes>16</votes>
    </rating>
    <tags>
      <tag count="1" id="7268">direct trade</tag>
      <tag count="1" id="4277">fair trade</tag>
      <tag count="1" id="8620">Ghettokaffe</tag>
      <tag count="1" id="55">hyggeligt</tag>
      <tag count="2" id="44">kaffe</tag>
      <tag count="1" id="7637">Kaffenørd</tag>
      <tag count="3" id="196">kvalitet</tag>
      <tag count="1" id="8621">lego</tag>
      <tag count="1" id="1026">Nørdet</tag>
      <tag count="1" id="23">nørrebro</tag>
      <tag count="1" id="7638">seeejt</tag>
      <tag count="1" id="8">venlig betjening</tag>
    </tags>
    <images>
      <image>
        <title>To Go kopper</title>
        <author id="5787">eye_q</author>
        <url>http://www.mitkbh.dk/uploads/th_0427c2be4b848247fd894413fe3ecc48.jpg</url>
        <width>200</width>
        <height>140</height>
        <created day="21" month="01" year="2009" />
      </image>
    </images>
    <reviews>
      <review id="6332">
        <title>Fantastisk Ghettokaffe</title>
        <created day="09" month="12" year="2008" />
        <author id="21408">Peter S</author>
        <commercialuse>true</commercialuse>
        <score>6</score>
        <tags>
          <tag id="8620">Ghettokaffe</tag>
          <tag id="8621">lego</tag>
        </tags>
        <funny>0</funny>
        <informative>1</informative>
        <body>
          &lt;p&gt;Hvor er det fedt at drikke verdensklasse kaffe i midten af  det rå KØBENHAVN med pusher, graffiti, gamle cykler og store hunde som sidemand.&lt;/p&gt;
 
          &lt;p&gt;Kaffen er fantastisk, betjeningen ligeså( måske ikke fantastisk.. nok mere entusiatisk) og så er det super med en fornemmelse af at man træder ind i et værksted- et kaffeværksted.&lt;/p&gt;
 
          &lt;p&gt;Alt i alt, et dejligt sted, hvor de har skåret alle unødige ligyldigheder væk.... ingen muffins, ingen dameblade, ingen kedlige sandwish og ingen dårlig kaffe!!!&lt;/p&gt;
 
          &lt;p&gt;De varmste kaffe anbefalinger herfra..:-)&lt;/p&gt;
 
          &lt;p&gt;ps. stor respekt til lego prislisten!!!!&lt;/p&gt;
        </body>
      </review>
      <review id="5289">
        <title>Ordentlig sejt!</title>
        <created day="03" month="05" year="2008" />
        <author id="5266">Momse</author>
        <commercialuse>true</commercialuse>
        <score>5</score>
        <tags>
          <tag id="196">kvalitet</tag>
          <tag id="7637">Kaffenørd</tag>
          <tag id="7638">seeejt</tag>
        </tags>
        <funny>1</funny>
        <informative>0</informative>
        <body>
          &lt;p&gt;Endnu end kaffeentutiast vil gerne tilslutte sig roserne til Coffee Collective. Super lækker kaffe, sød betjening og fedt miljø på den lækker-nørdede måde.&lt;/p&gt;
 
          &lt;p&gt;Kan anbefales af hele mit kaffehjerte...&lt;/p&gt;
        </body>
      </review>
      <review id="5072">
        <title>Bøj dig ved kaffens alter</title>
        <created day="30" month="03" year="2008" />
        <author id="2">morten</author>
        <commercialuse>true</commercialuse>
        <score>5</score>
        <tags>
          <tag id="23">nørrebro</tag>
          <tag id="44">kaffe</tag>
          <tag id="196">kvalitet</tag>
          <tag id="1026">Nørdet</tag>
        </tags>
        <funny>0</funny>
        <informative>2</informative>
        <body>
          &lt;p&gt;Coffee Collective er tydeligvis drevet af nørder. Og gud ske tak og lov for det. Her er tydelige prioriteringer: Kæmpe kaffekværn, kaffemaskinen midt i rummet og så et par tilfældige skamle spredt ud rundt omkring.&lt;/p&gt;
 
          &lt;p&gt;Men kaffen er god, barristaen har vundet verdensmesterskabet og det er altid rart at blive betjent af folk, der virkelig elsker at lave, det de laver. Og er man i tvivl om, hvorvidt de gør det, kan man jo besøge deres weblog og Flickr-billeder:&lt;/p&gt;
 
          &lt;p&gt;&lt;a href=&quot;http://coffeecollective.blogspot.com/&quot; onclick=&quot;window.open(this.href, &apos;_blank&apos;); return false;&quot;&gt;http://coffeecollective.blogspot.com/&lt;/a&gt;&lt;br /&gt;
          &lt;a href=&quot;http://www.flickr.com/photos/coffeecollective&quot; onclick=&quot;window.open(this.href, &apos;_blank&apos;); return false;&quot;&gt;http://www.flickr.com/photos/coffeecollective&lt;/a&gt;&lt;/p&gt;
 
          &lt;p&gt;Kaffen er i øvrigt dejlig og priserne helt i orden: 30 kroner for en Latte, 10 kroner for en croissant.&lt;/p&gt;
        </body>
      </review>
      <review id="4856">
        <title>Kaffe af den fine slags</title>
        <created day="25" month="02" year="2008" />
        <author id="535">cvs</author>
        <commercialuse>false</commercialuse>
        <score>5</score>
        <tags>
          <tag id="8">venlig betjening</tag>
          <tag id="44">kaffe</tag>
          <tag id="55">hyggeligt</tag>
          <tag id="196">kvalitet</tag>
          <tag id="4277">fair trade</tag>
          <tag id="7268">direct trade</tag>
        </tags>
        <funny>0</funny>
        <informative>1</informative>
        <body>
          &lt;p&gt;Fik ved juletid ved et tilfælde noget kaffe i hånden fra The Coffee Collective i hånden, og det viste sig at være rigtig god kaffe. &lt;br /&gt;
          Forleden så jeg at de fire gutter (hvoraf flere har en fortid hos Estate Coffe) har åbnet deres egen lille kaffebar på Jægersborggade. &lt;br /&gt;
          Lokalet er lille og der mangler stadig lidt inventar, men hyggeligt er det og kaffen er helt i top. Oven i det er betjeningen sød og venlig.&lt;br /&gt;
          Ud over kaffen kan man få the og evt. en croissant eller cookie til lækkersulten.&lt;/p&gt;
 
          &lt;p&gt;Alt i alt et rigtigt godt sted at få sit daglige kaffefix.&lt;/p&gt;
        </body>
      </review>
    </reviews>
  </node>
</response>
 
start.txt · Sidst ændret: 2009/02/24 14:45 af kng
 
Med mindre andet angivet, vil indhold på denne wiki blive frigjort under følgende licens:CC Attribution-Noncommercial-Share Alike 3.0 Unported
Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki