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/

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

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/