Detta API är utvecklat för att möjliggöra utveckling av enklare och mer avancerade sökapplikationer till K-samsök. Det har utvecklats för att förbättra både funktionalitet och prestanda.

Obligatoriska parametrar

Det finns ett fåtal parametrar som är gemensamma för samtliga API metoder. Dessa parametrar beskrivs kortfattat här.

method

Parameter som anger vilken API-metod som används. Om denna utelämnas återfår man endast ett felmeddelande. Anger man en metod som ej finns reflekteras även detta i ett felmeddelande. Skall man exempelvis använda metoden search skriver man method=search.

x-api

Vi har infört att man måste använda en API nyckel för att kunna söka i K-samsök. Detta har inget med att vi vill hålla folk från att använda K-samsök utan endast för att kunna samla statistik på användadet. För att få tag på en API nyckel behöver man endast kontakta någon hos Riksantikvarieämbetet. En nyckel kan erhållas på kort tid och utan krångel. Det finns också en test nyckel som är tänkt att användas av individer som vill utveckla en sökapplikation. Denna är inte avsedd att användas för färdiga applikationer och vi ser gärna att man använder den så lite som möjligt. Även under utvecklingsstadiet är det ok att be om en API nyckel till sin applikation. För att använda test nyckeln så skriver man x-api=test. Har man en riktig API nyckel är det bara byta ut ”test” mot denna.

Exempel

Grunden till ett anrop till K-samsöks API borde alltså exempelvis se ut på följande sätt:

http://www.kulturarvsdata.se/ksamsok/api?method=[metodnamn]&x-api=[api-nyckel]

Teckenkodning

K-samsöks API använder UTF-8. Att använda annan teckenkodning leder till att en sökning kan ge felaktigt resultat eller inget resultat.

En sida måste ha contentType satt till UTF-8

<meta content=”text/html;charset=UTF-8” http-equiv=”content-type”>

Och det formulär som anropar APIet måste också vara satt till UTF-8

<form action=”www.kulturarvsdata.se/ksamsok/api?…” accept-charset=”UTF-8″>