Verksamhetsutvecklare på Riksarkivet, med ansvar för publika APIer och länkade data.
Riksarkivet kommer snart att släppa sina första publika APIer. En av uppgifterna i projektet som tar fram dessa är att formulera och publicera användningsvillkor. Så, är det någon som kan tipsa om exempel på bra (tydliga, kortfattade) användningsvillkor för APIer?
I nästa etapp av Riksarkivets API-utveckling kommer vi att exponera metadata om arkivenheterna som länkade data (RDF, i första hand JSON-LD). Därmed måste vi nu fastställa hur resursernas URIer ska se ut. En lätt filosofisk fråga dyker då upp: vilket är snyggast, att path-delarna av URIerna är på svenska eller engelska?
http://data.riksarkivet.se/arkiv/{källa}/{persistent id}
eller
http://data.riksarkivet.se/archive/{källa}/{persistent id}
http://data.riksarkivet.se/term/{typ, på svenska}/{persistent id}
eller
http://data.riksarkivet.se/concept/{typ, på engelska}/{persistent id}
osv.
SCB ansvarar för data om läns- och kommunindelning. Här finns nedladdningsbara data, PDF och XLSX (!), men jag har inte lyckats hitta några länkade data (RDF) för detta. Har SCB detta så att det bara är jag som inte lyckats leta tillräckligt bra?
@jonass Tack! När det gäller villkor på data är det enkelt, Riksarkivet publicerar bara historiska data som är Public Domain. Vi kommer inte att ha någon SLA, men någon form av förhållningsregler måste vi ha.
@salgo60-ej-aktiv Varken län eller kommuner är persistenta över tid... Wikidata har det mesta, inklusive svensk administrativ indelning. Riksantikvarieämbetet har auktoriteter för län, kommun , landskap och socken som länkade data. Men, det vore intressant att veta om ansvarig myndighet har det också.
@dennis_priskorn Det är två befintliga APIer som vi kommer att tala om tydligare att de finns: IIIF för digitiserat arkivmaterial samt OAI-PMH för metadataskördning. Det senare är väl av begränsat publikt intresse, men iom att APIet finns där (för att leverera data till Archives Portal Europe) så ska vi åtminstone dokumentera det. Till sist så kommer ett nytt sök-API, som i slutändan ska ge liknande funktionalitet som de interaktiva tjänsterna på https://sok.riksarkivet.se/ Det sista lär vi behöva feedback från användare på så hör av dig om du är intresserad!
@salgo60-ej-aktiv TORA är ett forskningsprojekt, så resultatet är inte redo att släppas publikt än. Om/när vi kommer dit får vi se till att titta på dina synpunkter!
@dennis_priskorn TORA-projektet genomfördes tillsammans med Institutet för språk och folkminnen och forskare vid Uppsala universitet och Sveriges lantbruksuniversitet.
@Stefan-Wallin Alla RDF-URIer är självklart persistenta. Typen och värdet tillsammans ger en unik (persistent) identitet. MEN, det finns också en UUID även för termerna i datalagret, så detta är möjligt:
http://data.riksarkivet.se/term/{persistent id}
eller
http://data.riksarkivet.se/concept/{persistent id}
Då skulle befintliga begreppsresurser, som har /{typ}/{kod} i URIn definitivt behöva en owl:sameAs som pekar ut denna. Det är väl det som tilltalar mig mest, återstår att se om jag kan få med mig övriga intressenter här.
@Stefan-Wallin "snyggt" är förvisso inte relevant för systemen som ska använda data, men jag tycker det är relevant för människorna som ska läsa och förstå dokumentationen.
Min fundering handlar inte om URLer till API endpoints utan om RDF-URIer, dvs posternas länkade data-identifierare. Dessa kan sedan naturligtvis användas som URL för att hämta data, som JSON-LD eller RDF/XML. Nycklarna i JSON-LD-serialiseringen beror på vilka RDF properties man använder, dessa är normalt på engelska, typ schema:holdingArchive.
Den unika identifieraren, sista ledet i URIerna är normalt en persistent identifierare utan egen betydelse, oftast en Base 62-encodad UUID. Det finns dock befintliga data som hänvisar till begrepp med URIer där även id:t är ett betydelsebärande ord, typ
https://data.riksarkivet.se/tora/namingprinciple/modern
namingprinciple är begreppstyp och modern är ett värde. Dessa är kodvärden som inte ska ändras, inte namn att presentera. Det är för övrigt ett rätt bra exempel på dilemmat, vill vi ha engelska måste vi hitta bra översättningar för de svenska begreppstyperna och värdena.
Jag är kluven till vad som är bäst, det är därför jag frågar. Engelska är som du säger de facto-språk i datasammanhang, men översättningarna kan bli krystade.
@Magnus-Sälgö Off topic för min fråga, men jag ska försöka svara. Både arkivinstitutionen (Landsarkivet i Härnösand) och depå (Kusthöjden 46) är auktoritetsposter. Jag ser i databasen att arkivet är kopplat till Landsarkivet i Härnösand, men inte omedelbart var kopplingen till Kusthöjden 46 finns. I RDF-representationen kommer nog bägge att finnas med när den är komplett.
Arkivinstitution med schema:holdingArchive
Depå måste jag reda ut mer om för att veta vad för property
@Magnus-Sälgö Jag hade två exempel, exakt identifierare är ointressant, det jag funderar på är om det skall vara /arkiv/ eller /archive/, /term/ eller /concept/ osv. Men, om det hjälper att se principen:
Vilken URI är snyggast för https://sok.riksarkivet.se/arkiv/1WBIheq4rX61h03Gjpu0Y3 ?
http://data.riksarkivet.se/arkiv/arkis/1WBIheq4rX61h03Gjpu0Y3
eller
http://data.riksarkivet.se/archive/arkis/1WBIheq4rX61h03Gjpu0Y3
I nästa etapp av Riksarkivets API-utveckling kommer vi att exponera metadata om arkivenheterna som länkade data (RDF, i första hand JSON-LD). Därmed måste vi nu fastställa hur resursernas URIer ska se ut. En lätt filosofisk fråga dyker då upp: vilket är snyggast, att path-delarna av URIerna är på svenska eller engelska?
http://data.riksarkivet.se/arkiv/{källa}/{persistent id}
eller
http://data.riksarkivet.se/archive/{källa}/{persistent id}
http://data.riksarkivet.se/term/{typ, på svenska}/{persistent id}
eller
http://data.riksarkivet.se/concept/{typ, på engelska}/{persistent id}
osv.
Vet inte om detta är rätt kategori, men prövar här. Jag använder EntryScape för att registrera Riksarkivets nyligen publicerade APIer till dataportalen. Jag lyckas dock inte, de går inte att hitta. Så, jag gör uppenbarligen något fel, frågan är bara vad. Så här ser det ut i EntryScape: https://www.awesomescreenshot.com/image/25366481?key=cfbf51aee0a804280c2e3cc62f50e718
Ni som har publika APIer i drift, vad har ni för lösning för att samla användningsstatistik för APIerna? För webbsidor finns ett antal lösningar, men jag ser inget lika uppenbart för APIer om man inte går genom en API gateway. Vi gjorde ett provskott med AWStats och servrarnas access-loggar, men det fungerade inte helt tillfredsställande.
@salgo60-ej-aktiv Det ligger i sakens natur att län och kommuner förändras över tid, län har slagits samman, kommuner bytt län och kommuner slagits samman och brutits loss.
Vad jag frågade efter är officiella länkade data för aktuell läns- och kommunindelning. Sedan vore naturligtvis idealet om sådana data kunde omfatta resurser för historiska län/kommuner också, med properties för vilken tidsperiod de gällde.
Läns- och kommunkoder är som konstaterats inte beständiga, så de bör inte ingå i resursernas URIer utan vara ordinära properties i resurserna.
@salgo60-ej-aktiv Varken län eller kommuner är persistenta över tid... Wikidata har det mesta, inklusive svensk administrativ indelning. Riksantikvarieämbetet har auktoriteter för län, kommun , landskap och socken som länkade data. Men, det vore intressant att veta om ansvarig myndighet har det också.
SCB ansvarar för data om läns- och kommunindelning. Här finns nedladdningsbara data, PDF och XLSX (!), men jag har inte lyckats hitta några länkade data (RDF) för detta. Har SCB detta så att det bara är jag som inte lyckats leta tillräckligt bra?