Exempel på bra användningsvillkor för APIer

nilsw-ra

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?

Ainali

@nilsw-ra Jag gillar MediaWikis API-etikett. Kortfattad, inget krångel, och lite praktisk hjälp.

jonass

@nilsw-ra Hej, Alla offentliga organisationer gör tyvärr lite olika idag, vilket är olyckligt. Mitt bästa tips är att särskilja på villkor för API:ets data och användningsvillkoren/SLA för nyttjandet av tjänsten. DIGG har nämligen en väldigt bra rekommendation för val av licens för data, läs mer https://www.digg.se/utveckling-av-digital-forvaltning/oppna-och-delade-data/offentliga-aktorer/oppna-licenser-och-immaterialratt. Arbetsförmedlingen/JobTech försöker att inte reglera/lova för mycket i SLA:ar. Men däremot försöker vi vara öppna med vilken faktiskt tillgänglighet våra API:er haft historiskt så användaren kan göra ett välinformerat beslut om vårt API håller måttet. Se vår tillgänglighet: https://statping.jobtechdev.se/

Magnus Sälgö

@ainali snyggt även länken till deras backlog längst ned på sidan...

Dennis_Priskorn

@nilsw-ra sa i Exempel på bra användningsvillkor för APIer:

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?

Har dessa API:er tagits fram med genom att testa på användare? Finns det nått publicerat om det? Jag känner mig nyfiken. Har vi en rekommendation från DIGG om hur man bäst tar fram en API?

Dennis_Priskorn

@jonass sa i Exempel på bra användningsvillkor för APIer:

Arbetsförmedlingen/JobTech försöker att inte reglera/lova för mycket i SLA:ar. Men däremot försöker vi vara öppna med vilken faktiskt tillgänglighet våra API:er haft historiskt så användaren kan göra ett välinformerat beslut om vårt API håller måttet. Se vår tillgänglighet: https://statping.jobtechdev.se/

Det gillar jag starkt! Då ser man om det är nått man vågar bygga mot och ni på insidan har motivation att hålla bra nivå och sätta larm på grejerna så ni får en ping om de slutar funka.

WMF har väldigt bra upptider på sina API:er har jag märkt, de publicerar också all statistik via Grafana översikter och man kan direkt se om en incident inträffat och följa när den lösas (om inte det är en säkerhetsincident såklart)

Se tex https://grafana.wikimedia.org/d/000000489/wikidata-query-service?orgId=1&viewPanel=8&from=now-30m&to=now&refresh=1d som jag använder för att se om WDQS är i ordning (ska helst vara runt 1-2 min för alla servrar).

nilsw-ra

@ainali Håller med, får se om jag kan få igenom något lika obyråkratiskt!

nilsw-ra

@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.

nilsw-ra

@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!

Magnus Sälgö

@nilsw-ra spännande vore bra om kulturAPI:er hade lite liknande design. Kolla in https://portrattarkiv.se SPA dom tycker jag har bra API dock ej dokumenterat men enkla att prata med ;-(

SPA innehåller > 800 000 scannade bilder som en gubbe scannat in. Sedan har några skapat en web för dessa scannade bilder som

OCR:ar texten
kör ML på texten och kopplar den till rätt metadata
användare kan sedan konfirmera metadatat som ML föreslagit
söker du via api:et så får du en score dvs. sannolikheten att bilden motsvarar det jag söker efter

API som finns

Exempel vad jag byggt denna månad github.com/salgo60/spa2Commons

Notebook som söker ut folk på en kyrkogård som saknar bild i Wikidata och skickar den till portrattarkiv.se
- Exempel sökning Abraham Ahlén 1844 samma som WD Q29341994
  - score 31.16589 på sj9PGLAlnmUAAAAAAA20qQ
  - score 29.573391 på sj9PGLAlnmUAAAAAAA2odw
  - ....
javascript som söker från Wikipedia/Wikicommons om bilder finns för en person och sedan laddar upp den på Wikicommons se GITHUB och katalog med snart 3000 uppladdade bilder
Notebook som hittar poster i SPA som säger samma som Wikipedia
- där egenskapen SPA Property:P4819 saknas i WD så sätter jag den genom att köra Open Refine se video
- SPA länkar "samma som" Wikipedia --> jag kör igenom deras API:et efter dessa och sätter i Wikidata egenskapen Property:P4819 och skapar sedan listor för personer i Wikidata som saknar en bild men som SPA säger att dom har en bild för

GITHUB repositories
Vore trevligt om Riksarkivet satte upp lite fler repositories där man kan kommunicera jmf Tora där var det tyvärr tycker jag lite segt att kommunicera med Karswall plus att Wikidata och Tora har lite olika semantik vilket störde mig. Tora har socken i samma objekt medans Wikidata delar på församling och socken och många fler.... dock har Tora samma som WD och vi har SPARQL federation....

Tora -> egenskap WD Property:P4820
- karta vad vi har i Wikidata är tyvärr "skitigt" , SPARQL Federation WD <-> Tora
- några av dom tasks jag skapade T234179 T199977, T200066
- diskussioner hos oss sep 2019 om vad som bör göras.... dog tyvärr ut...

OT koordinater: Tora dom "fega" med SWEREF 99 och WGS 84 exempel Skånelaholm Toraid = 12371

nilsw-ra

@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!

Magnus Sälgö

@nilsw-ra ?!?! vi jobbar hellre med forskningsprojekt för då är min erfarenhet att det är mera fart och driv framåt... när saker går på drift brukar inget hända....

Jag och en Wikipedia användaren Yger var och träffade Karswall hos er men det var för lite enligt mig.... jag har även sprungit på Karswall när jag snackade på Linked Data Sweden där jag vid 11:45 pratade om svårigheterna med att koppla ihop sig med Riksarkivet SBL

kollar vi på ett ungt projekt som Svenskt kvinnobiografiskt lexikon SKBL så är en sådan organisation mer på tå jmf med Riksarkivet
- SKBL levererar på
  * svenska/engelska texter --> vi länkar dom från en:Wikipedia en av världens 20 största websiter
  * SKBL har API / strukturerat data
  * jag har i dec 2020 pratat på deras ledningsgruppsmöte om att dom borde lyfta sig till 5stardata se presentation...
  - SKBL är del i community projektet Women in Red --> skapa4 fler artiklar om kvinnor i Wiki världen
- vi kan via SKBL API;et hämta strukturerad data jmf Riksarkivet SBL där vi får webscrapa och gissa etc...
frågor som detta med Riksarkivet SBL att dom skall levererar en bättre produkt ser jag ingen kanal för. Känns inte att det finns produktägare hos Riksarkivet som lyssnar... etc....
vän av ordning kan se att SKBL levererar 100 ggr fler kvinnliga biografier än SBL och en bra digital produkt. Det tog 4 år för SKBL att köra om SBL som gjort detta i 100 år...

Ingen är gladare än jag om det bli enklare att skapa mervärde med Riksarkivet --> co-creation och win-win för alla

Dennis_Priskorn

@nilsw-ra sa i Exempel på bra användningsvillkor för APIer:

TORA är ett forskningsprojekt

Definiera gärna "forskningsprojekt". Menar du att ni gör det ihop med forskare från en högskola?

Björn Hagström

@ainali Den var enkel och snygg.

Björn Hagström

Om du stöter på denna så är den inte uppdaterad och bör inte användas:
https://www.apilicens.se/

nilsw-ra

@dennis_priskorn TORA-projektet genomfördes tillsammans med Institutet för språk och folkminnen och forskare vid Uppsala universitet och Sveriges lantbruksuniversitet.

nilsw-ra

@salgo60-ej-aktiv Tja, men projekt är per definition avgränsade i tid och scope. När projektet är avslutat finns inga resurser att göra något med resultatet förrän det kommer in i produktion. Förhoppningsvis kommer dock ett annat projekt (Dataplattform) att kunna föra TORA till produktion med tiden.