Brukerhistorier API-beskrivelse (alle detaljer) ()
Brukerhistorier API-beskrivelse (alle detaljer)
API-beskrivelsen
Som konsument av API ønsker jeg informasjon om kostnader og trafikkbegrensninger for bruk av API-et slik at jeg kan ha forutsigbare rammer for min bruk av dataene.
BAM15 - Som ansvarlig for API-management ønsker jeg å publisere informasjon om kostnader og trafikkbegrensninger for mine API-er, slik at potensielle brukere av mine API-er slipper å spørre meg om denne informasjonen
BA31. Som API-konsument ønsker jeg informasjon om eventuelle økonomiske betingelser for bruk av API-er, slik at jeg kan vurdere hvorvidt det er aktuelt å betale for bruk av API-et.
BFP026: Som profesjonell API-konsument ønsker jeg forutsigbare økonomiske og juridiske rammer rundt (helst åpen/gratis) tilgang til offentlig data slik at jeg kan lage gode business cases.
Som API-konsument ønsker jeg å se en SLA knyttet til API-et slik at jeg kan vurdere om det tilfredsstiller mine krav til bruk
BFP023: Som API-konsument ønsker jeg å se hvilken SLA som er forbundet med API et slik at jeg kan vurdere om det tilfredsstiller mine krav for bruk.
Som API-konsument ønsker jeg at rettslige rammer og lisens er tydelig beskrevet slik at jeg kan vurdere om det er forenelig med min bruk av dataene
BFP032: Som API-konsument ønsker jeg klar informasjon rundt lisensen på dataene APIet tilbyr for å raskt se om dette er forenlig med min bruk av dataene.
BA30. Som API-konsument ønsker jeg informasjon om hvilke hjemler som gir tilgang til API-er der tilgangen er begrenset, slik at jeg kan vurdere om min virksomhet har lov til å benytte API-et til det aktuelle formålet.
BA35. Som API-konsument ønsker jeg at det er tydelig hva som er de rettslige rammene for bruk av API-ene slik at jeg kan være sikker på at jeg ikke kan få krav mot meg senere, f.eks. NLOD.
Som API-konsument ønsker jeg informasjon om kapasitet, ytelse og pålitelighet slik at jeg kan være sikker på at API-et kan benyttes i mine forretningskritiske tjenester
BA17. Som API-konsument ønsker jeg beskrivelse av API-et sin kapasitet slik at jeg vet om jeg trenger en egen server for sluttbrukerapplikasjoner ved svært høy trafikk.
BFDK13 - Som konsument av et åpent api ønsker jeg informasjon om hvor pålitelig leveransen av data er (forventet oppetid, responstid ved feil osb) slik at jeg kan gjøre en tilstrekkelig ROS-analyser for min integrasjon
BA28. Som API-konsument ønsker jeg informasjon om ytelsesmessige (svartid, antall oppslag) begrensninger i API-et, slik at jeg kan vurdere om API-et har god nok ytelse til mitt formål.
BFP027: Som API-konsument ønsker jeg at dokumentasjonen til API-er jeg skal bruke har informasjon om kvalitet og tilgjengelighet, slik at jeg slipper mange henvendelser til API-tilbyder for å få svar på enkle ting.
Som API-forvalter ønsker jeg eierskapet og ansvaret til API-eier kommer tydlig frem slik at man unngår uklarheter
BAM06 - Som ansvarlig for API-management ønsker jeg å kunne fordele eierskap og ansvar for de enkelte API-ene til det forretningsområdet som er dataforvalter/dataeier, slik at de kan være mest mulig selvbetjente og redusere flaskehalser (“publisher portal”)/sikre nærhet og dermed kvalitet (ansvarliggjøring av den rette aktøren)
BAM11 - Som ansvarlig for API-management ønsker jeg å sikre eierskap av API-ene hos forretningseier/dataeier for å sikre kvalitet og eierskap.
BAM18 - Som ansvarlig for flere datasett og medfølgende API’er ønsker jeg å ha kontroll på de datasettene forretningsenheten min tilbyr og enkelt gi tilgang til datasettene ved behov slik at jeg kan utføre ansvaret jeg har på en enkel måte
27. Som API-katalogeier ønsker jeg å koordinere beskrivelsene av API-ene som inngår i min katalog, slik at beskrivelsene fremstår som ensartet for de som skal benytte API-ene.
BTI008 Som konsument av data fra offentlige virksomheter ønsker jeg at de offentlige virksomhetene inngår avtaler med sine leverandører som gjør det tydelig hvem som eier dataene, og stiller krav til at de skal være gjøres tilgjengelige uten kostnader, slik at ikke den offentlige virksomheten hindres i å dele sine data med meg som følge av at kostnadene blir for store.
Som API-konsument ønsker jeg kontaktinformasjon slik at man kan få hjelp
BFP002: Som API-konsument ønsker jeg enhetlig dokumentasjon og mulighet til “kundeservice” fra tjenesteleverandør.
BFP011: Som API-konsument ønsker jeg et kontaktpunkt hos API-eier slik at man kan gi tilbakemelding og spørsmål.
Som API-konsument ønsker jeg å få tekstlig beskrivelse av et API slik at jeg kan forstå hvordan jeg skal bruke et API
BFP009: Som API-konsument ønsker jeg å få dokumentere hvordan en kan oppdatere en egen kopi slik at en til hver tid bruker korrekte data.
Som API-konsuement ønsker jeg en tematisk oversikt over API slik at jeg lett kan finne fram
35. Som API-katalogeier ønsker jeg å kategorisere API-innslagene, slik at det kan differensieres mellom de.
BA32. Som API-konsument (gründer) ønsker jeg en tematisk oversikt over offentlige API slik at jeg kan lage nye tjenester.
Som API-konsument ønsker API-beskrivelsen refererer til begreper slik at jeg kan forstå innholdet i API-et
BA5. Som API-konsument ønsker jeg at alle begreper linker direkte til en forklaring av begrepet slik at jeg slipper å lete gjennom dokumentasjonen. [kommentar: forskjell på begrep i den tekniske dokumentasjonen (f.eks. parameter i forespørsel) vs. begrep i datasettet (f.eks. fagtermer)]
BA39. Som API-konsument ønsker jeg at begreper i API-ene er dokumentert slik at jeg forstår dokumentasjonen og bruker dataene i API-ene rett.
BB6. Som API-konsument ønsker jeg at semantikken rundt dataene er forklart (dataene er definert), slik at jeg kan ta et informert valg om å bruke dataene fordi jeg forstår kontekst, formål og omfanget av dem. [dokumentasjon]
BFP019: Som API-konsument ønsker jeg at apiene inneholder referanser til begrepene som er brukt i apiene slik at jeg forstår detaljene og bruker dataene korrekt.
Som API-konsument ønsker jeg at API-beskrivelsen refererer til informasjonsmodeller slik at jeg forstår strukturen i API-ets respons
BFP003: Som API-konsument ønsker jeg å kunne se eventuelt tilknyttede informasjonsmodeller der det finnes, slik at jeg også kan finne og kvalitetssikre data og informasjon.
BB9. Som API-konsument (datajournalist) ønsker jeg å få forklaringer/dokumentasjon på hvordan dataene henger sammen slik at jeg kan spare tid på semantisk fortolkning (kobling mot datakatalogen?) [dokumentasjon]
Som API-konsument ønsker jeg referanser til brukte kodeverk slik at jeg kan forstå hvordan de skal fortolkes
BFP018: Som API-konsument ønsker jeg at apiene inneholder referanser til lokale kodeverk som forklarer innholdet i apiene slik at jeg forstår detaljene i apiene.
BA18. Som API-konsument ønsker jeg lenker til aktuelle kodeverk (f.eks. kommunenummer, næringskoder) slik at jeg lett kan hente støtte-datasett og dermed benytte datasettet fullt ut.
BB16. Som API-konsument ønsker jeg at støttedatasett (f.eks. kodelister) er omtalt i dokumentasjonen slik at jeg kan anvende data fullt ut.[dokumentasjon]
Som API-konsument ønsker jeg informasjon om tilgang til dataene (tilgangsnivå) slik at jeg kan forstå hvordan jeg skal ta det i bruk
BA29. Som API-konsument ønsker jeg informasjon om hvordan jeg kan skaffe meg tilgang til API-er som ikke er offentlig tilgjengelig. [Kommentar: manglar “slik at <forretningsverdi>”]
BB7. Som API-konsument ønsker jeg at det angis tydelig i dokumentasjonen hvilke data som er tilgjengelig, men også hva som ikke er tilgjengelig, slik at jeg slipper merarbeid pga. uklar dokumentasjon. [dokumentasjon]
Som API-forvalter ønssker jeg å beskrive kjente kvalitetsvurderinger slik at konsumenten kan forstå API-et bedre
BA10.Som API-konsument ønsker jeg en indikasjon på hvor dynamisk datasettet er, slik at jeg har en idé om hvor ofte jeg trenger å lese data på nytt.
BFP008: Som API-konsument ønsker jeg å vite oppdateringsfrekvens slik at jeg kan bestemme egen oppdatering.
BFP020: Som API-konsument ønsker jeg informasjon om oppdateringsfrekvens av dataene eller om dataene er statiske.
Som API-konsument ønsker jeg å forstå om API-et tilbyr datamimimering slik at jeg kan understøtte godt personvern
BFP025: Som API-konsument ønsker jeg å se hvilke muligheter det finnes for konfigurasjon både hos meg og hos API-leverandør for å begrense tilgjengelig data til mitt faktiske formål. Kommentar: Dataminimering?
Som API-konsument ønsker jeg å se eksempler på kall slik at jeg kan raskt sette meg inn i bruk av API-et
BA4. Som API-konsument ønsker jeg eksempler på API-requests slik at jeg kan komme fort i gang.
Som API-konsument ønsker jeg å vite hva slags intereaksjonsform/type som API-et tilbyr slik at jeg kan vite om det dekker mine behov
Som API-konsument ønsker jeg å vite hvilken interaksjonsform som tilbys i APIet (spørring, feed, fil) , slik at jeg kan vite om det dekker mine behov.
Som API-konsument ønsker jeg referanser til dokumentasjon som ikke beskrives i API-beskrivelsen slik at jeg kan nøste meg videre
BA3. Som API-konsument ønsker jeg at det pekes til gode landingssider for API-et slik at jeg raskt settes i stand til å ta det i bruk.
BB15. Som API-konsument ønsker jeg at relevante opplysninger som ikke er tilgjengelig i API-et er omtalt i dokumentasjonen, slik at jeg kan bruke API-et riktig. [dokumentasjon]
BA22. Som API-konsument (app-utvikler) ønsker jeg en landingsside hvor jeg kan stille spørsmål om bruk av API-et slik at jeg kan bruke det mest mulig hensiktsmessig, og gjerne med henvisninger til kjent brukt av API-et.
BA23. Som API-konsument (app-utvikler) ønsker jeg en landingsside hvor jeg får tilgang til FAQ om API-et. [Kommentar: manglar “slik at <forretningsverdi>”]
Som API-konsument ønsker jeg oversikt over testmiljø og syntetiske data slik at jeg kan teste ut API-ene
BFP016: Som API-konsument ønsker jeg en oversikt over hvilke versjoner som er tilgjengelig i hvilke miljø slik at jeg vet hva jeg kan teste mot. (prod og test)
8. Som API-forvalter som tilbyr data som ikke er åpne ønsker jeg å synliggjøre testmiljø for mine API-er slik at de er lette å oppdage for brukerne
BFP013: Som API-konsument ønsker jeg en oversikt over tilgjengelige testmiljø for å teste ut apiene.
BFP024: Som API-konsument ønsker jeg i de tilfeller hvor API er basert på et lukket datasett å koble meg til et miljø med syntetisk data for bruk i utvikling og test.
Som API-forvalter ønsker jeg at det med API-beskrivelsen følger en veileder slik at jeg kan følge beste praksis
BA55. Som API-konsument, ønsker jeg at API-et er designet etter en felles “beste praksis” som gjelder for API-er i API-katalogen, slik at jeg lett kjenner meg igjen på tvers av API-ene i katalogen.
6. Som API-forvalter ønsker jeg at de aktivitetene jeg må gjøre og de standardene jeg må forholde meg til for å gjøre API-dokumentasjonen tilgjengelig i en nasjonal API-katalog, også gir verdi for andre, kommersielle, internasjonale API-kataloger, f.eks. synliggjøring på søkemotorer, ref Schema.orgs arbeid med vokabular for WebAPI http://pending.webschemas.org/WebAPI
BAM02 - Som ansvarlig for API-management ønsker jeg å dokumentere mitt API slik at utviklere raskt kan benytte API-et for tilgang til de data API-et representerer
BA40. Som API-tilbyder* ønsker jeg retningslinjer og beste praksis for dokumentasjon av API-ene mine slik at jeg kan dokumentere så effektivt og bra som mulig.
EPOS 9: Som API-konsument ønsker jeg oversikt over hvem som bruker et API slik at jeg kan forstå det bedre
BA14. Som API-konsument ønsker jeg lenker til applikasjoner som bruker datasettet, slik at jeg kan finne gode eksempler på bruk av API-et og datasettet. [kommentar: også programvarebibliotek og anna kodeverk som er relevant
BFP014: Som API-konsument ønsker jeg oversikt over tilgjengelige referanseimplementasjoner slik at jeg raskere kan komme i gang med å bruke apiene.
BB5. Som API-konsument ønsker jeg å få tilgang til eksempler på bruk av API-et slik at jeg kan se mulighetene for bruk og bedre forstå hva API-et er ment å brukes til. [dokumentasjon]
BFP022: Som API-konsument ønsker jeg eksempler/mal på bruk slik at jeg kan ta i bruk nye datasett raskest mulig.
19. Som API-forvalter ønsker jeg kontaktinfo til de som bruker mine API slik at jeg kan ta kontakt med de om brukerundersøkelser, driftsmeldinger, endring av API, nye API og liknande. [dersom jeg ikke har egne løsninger for dette allerede]
Som API-konsument ønsker jeg informasjon om et API har varsligskanal slik at jeg kan fange opp endringer
BA43. Som API-konsument ønsker jeg å bli varslet om at et API er “deprecated” (skal tas ut av bruk), slik at jeg kan oppdatere min applikasjon.
Som API-konsument ønsker jeg informasjon hvordan endringer i modell varsles slik at jeg kan fange opp endringer
BFP030: Som API-konsument ønsker jeg å kunne spørre produsent om mer og bedre data slik at vi kan tilby et bedre og mer helhetlig bilde.
BFP017: Som API-konsument ønsker jeg en endringslogg så tidlig som mulig slik at jeg vet hva som har endret seg mellom versjoner.
Som API-konsument ønsker jeg å se relasjoner slik at jeg flere som tilbyr liknende API
BTI010 Som API-tilbyder ønsker jeg å kunne se om andre tilbyr det samme eller nesten det samme som meg, så at det er mulig å harmonisere mellom “oss” [Livar: Case der det er fleire API-er som tilbyr det samme? Marit: Brreg og Skatt som har same datasett i FDK. Mathias: Felles studentsystem (FS) i UH-sektoren innheld personinformasjon. Kan ikkje konsoliderast med HR-data. Kan ikkje legge ned ein av dei. Dekker relasjonsfeltet i DCAT behovet?]
Som API-konsument ønsker jeg å forstå om API-et er tilrettelagt for bruk med brukers samtykke eller fullmakt
Som sluttbruker ønsker jeg å gi samtykke til at en 3dje part kan innhente mine data fra offentlig myndighet slik at jeg slipper å tilgjengeliggjøre dataene selv
Som sluttbruker ønsker jeg å gi samtykke til at en offentlig myndighet kan innhente mine data fra en 3dje part slik at jeg slipper å tilgjengegliggjøre dataene selv.
Som sluttbruker ønsker jeg at en offentlig aktør skal ha tilgang til data om meg hos en annen offentlig aktør
Som sluttbruker ønsker jeg at en privat virksomhet skal ha tilgang til data om meg fra en tredjepart (app) slik at jeg kan slippe å tiljgengeliggjøre dataene selv
Som API-konsument ønsker jeg at dokumentasjonen er genererert fra kode slik at jeg kan stole på at den er oppdatert
BFP005: Som API-konsument ønsker jeg at dokumentasjonen skal integreres i koden slik at den til enhver tid er oppdatert
BA41. Som API-konsument som benytter verktøy for å generere deler av kildekoden ønsker jeg at API-et er dokumentert iht “Open API Specification”, slik at jeg kan bruke kodegenereringsverktøy for å generere mye av den kildekoden som trengs for å bruke API-et fremfor å måtte skrive den selv [ref epost]
11. Som API-forvalter/eier ønsker jeg å generere dokumentasjon ut fra koden eller tester, slik at jeg er sikker på at dokumentasjonen til enhver tid er oppdatert.
BB18. Som API-konsument ønsker jeg at kildekoden til API-tjenesten er tilgjengelig som åpen kildekode, slik at jeg kan lese kildekode for å forstå APIet og kunne bruke det optimalt [dokumentasjon]
Som API-konsument ønsker jeg at det er gjort en sikkerhetsvurdering slik at krav til innebygd personvern er best mulig ivaretatt
BFP001: Som API-forvalter ønsker jeg at det knyttes opplysninger om sikkerhetsvurderinger tilknyttet felt i API’et (identifiserende, lokaliserende, krav til sikring, osv.) slik at hensyn til innebygd personvern i større grad er ivaretatt for det datasettet som publiseres.
Som API-konsument ønsker jeg hjelp til tilgang til nøkler eller tokens for raskt å ta i bruk API-et
BA2. Som API-konsument ønsker jeg umiddelbar tilgang (slipper å vente på manuell tildeling av API-nøkler og tokens) til data (eller testdata) slik at jeg kan vurdere og eventuelt ta i bruk API-et umiddelbart.
BAM09 - Som ansvarlig for API-management ønsker jeg å kunne administrere nøkler gitt til de enkelte konsumentene slik at jeg enkelt kan fjerne ev. misbruk av API-et
API-beskrivelsen Som konsument av API ønsker jeg informasjon om kostnader og trafikkbegrensninger for bruk av API-et slik at jeg kan ha forutsigbare rammer for min bruk av dataene.
API-beskrivelsen Som API-konsument ønsker jeg å se en SLA knyttet til API-et slik at jeg kan vurdere om det tilfredsstiller mine krav til bruk
API-beskrivelsen Som API-konsument ønsker jeg at rettslige rammer og lisens er tydelig beskrevet slik at jeg kan vurdere om det er forenelig med min bruk av dataene
API-beskrivelsen Som API-konsument ønsker jeg informasjon om kapasitet, ytelse og pålitelighet slik at jeg kan være sikker på at API-et kan benyttes i mine forretningskritiske tjenester
API-beskrivelsen Som API-forvalter ønsker jeg eierskapet og ansvaret til API-eier kommer tydlig frem slik at man unngår uklarheter
API-beskrivelsen Som API-konsument ønsker jeg kontaktinformasjon slik at man kan få hjelp
API-beskrivelsen Som API-konsument ønsker jeg å få tekstlig beskrivelse av et API slik at jeg kan forstå hvordan jeg skal bruke et API
API-beskrivelsen Som API-konsuement ønsker jeg en tematisk oversikt over API slik at jeg lett kan finne fram
API-beskrivelsen Som API-konsument ønsker API-beskrivelsen refererer til begreper slik at jeg kan forstå innholdet i API-et
API-beskrivelsen Som API-konsument ønsker jeg at API-beskrivelsen refererer til informasjonsmodeller slik at jeg forstår strukturen i API-ets respons
API-beskrivelsen Som API-konsument ønsker jeg referanser til brukte kodeverk slik at jeg kan forstå hvordan de skal fortolkes
API-beskrivelsen Som API-konsument ønsker jeg informasjon om tilgang til dataene (tilgangsnivå) slik at jeg kan forstå hvordan jeg skal ta det i bruk
API-beskrivelsen Som API-forvalter ønssker jeg å beskrive kjente kvalitetsvurderinger slik at konsumenten kan forstå API-et bedre
API-beskrivelsen Som API-konsument ønsker jeg å forstå om API-et tilbyr datamimimering slik at jeg kan understøtte godt personvern
API-beskrivelsen Som API-konsument ønsker jeg å se eksempler på kall slik at jeg kan raskt sette meg inn i bruk av API-et
API-beskrivelsen Som API-konsument ønsker jeg å vite hva slags intereaksjonsform/type som API-et tilbyr slik at jeg kan vite om det dekker mine behov
API-beskrivelsen Som API-konsument ønsker jeg referanser til dokumentasjon som ikke beskrives i API-beskrivelsen slik at jeg kan nøste meg videre
API-beskrivelsen Som API-konsument ønsker jeg oversikt over testmiljø og syntetiske data slik at jeg kan teste ut API-ene
API-beskrivelsen Som API-forvalter ønsker jeg at det med API-beskrivelsen følger en veileder slik at jeg kan følge beste praksis
API-beskrivelsen EPOS 9: Som API-konsument ønsker jeg oversikt over hvem som bruker et API slik at jeg kan forstå det bedre
API-beskrivelsen Som API-konsument ønsker jeg informasjon om et API har varsligskanal slik at jeg kan fange opp endringer
API-beskrivelsen Som API-konsument ønsker jeg informasjon hvordan endringer i modell varsles slik at jeg kan fange opp endringer
API-beskrivelsen Som API-konsument ønsker jeg å se relasjoner slik at jeg flere som tilbyr liknende API
API-beskrivelsen Som API-konsument ønsker jeg å forstå om API-et er tilrettelagt for bruk med brukers samtykke eller fullmakt
API-beskrivelsen Som API-konsument ønsker jeg at dokumentasjonen er genererert fra kode slik at jeg kan stole på at den er oppdatert
API-beskrivelsen Som API-konsument ønsker jeg at det er gjort en sikkerhetsvurdering slik at krav til innebygd personvern er best mulig ivaretatt
API-beskrivelsen Som API-konsument ønsker jeg hjelp til tilgang til nøkler eller tokens for raskt å ta i bruk API-et
Som konsument av API ønsker jeg informasjon om kostnader og trafikkbegrensninger for bruk av API-et slik at jeg kan ha forutsigbare rammer for min bruk av dataene. BAM15 - Som ansvarlig for API-management ønsker jeg å publisere informasjon om kostnader og trafikkbegrensninger for mine API-er, slik at potensielle brukere av mine API-er slipper å spørre meg om denne informasjonen
Som konsument av API ønsker jeg informasjon om kostnader og trafikkbegrensninger for bruk av API-et slik at jeg kan ha forutsigbare rammer for min bruk av dataene. BA31. Som API-konsument ønsker jeg informasjon om eventuelle økonomiske betingelser for bruk av API-er, slik at jeg kan vurdere hvorvidt det er aktuelt å betale for bruk av API-et.
Som konsument av API ønsker jeg informasjon om kostnader og trafikkbegrensninger for bruk av API-et slik at jeg kan ha forutsigbare rammer for min bruk av dataene. BFP026: Som profesjonell API-konsument ønsker jeg forutsigbare økonomiske og juridiske rammer rundt (helst åpen/gratis) tilgang til offentlig data slik at jeg kan lage gode business cases.
Som API-konsument ønsker jeg å se en SLA knyttet til API-et slik at jeg kan vurdere om det tilfredsstiller mine krav til bruk BFP023: Som API-konsument ønsker jeg å se hvilken SLA som er forbundet med API et slik at jeg kan vurdere om det tilfredsstiller mine krav for bruk.
Som API-konsument ønsker jeg at rettslige rammer og lisens er tydelig beskrevet slik at jeg kan vurdere om det er forenelig med min bruk av dataene BFP032: Som API-konsument ønsker jeg klar informasjon rundt lisensen på dataene APIet tilbyr for å raskt se om dette er forenlig med min bruk av dataene.
Som API-konsument ønsker jeg at rettslige rammer og lisens er tydelig beskrevet slik at jeg kan vurdere om det er forenelig med min bruk av dataene BA30. Som API-konsument ønsker jeg informasjon om hvilke hjemler som gir tilgang til API-er der tilgangen er begrenset, slik at jeg kan vurdere om min virksomhet har lov til å benytte API-et til det aktuelle formålet.
Som API-konsument ønsker jeg at rettslige rammer og lisens er tydelig beskrevet slik at jeg kan vurdere om det er forenelig med min bruk av dataene BA35. Som API-konsument ønsker jeg at det er tydelig hva som er de rettslige rammene for bruk av API-ene slik at jeg kan være sikker på at jeg ikke kan få krav mot meg senere, f.eks. NLOD.
Som API-konsument ønsker jeg informasjon om kapasitet, ytelse og pålitelighet slik at jeg kan være sikker på at API-et kan benyttes i mine forretningskritiske tjenester BA17. Som API-konsument ønsker jeg beskrivelse av API-et sin kapasitet slik at jeg vet om jeg trenger en egen server for sluttbrukerapplikasjoner ved svært høy trafikk.
Som API-konsument ønsker jeg informasjon om kapasitet, ytelse og pålitelighet slik at jeg kan være sikker på at API-et kan benyttes i mine forretningskritiske tjenester BFDK13 - Som konsument av et åpent api ønsker jeg informasjon om hvor pålitelig leveransen av data er (forventet oppetid, responstid ved feil osb) slik at jeg kan gjøre en tilstrekkelig ROS-analyser for min integrasjon
Som API-konsument ønsker jeg informasjon om kapasitet, ytelse og pålitelighet slik at jeg kan være sikker på at API-et kan benyttes i mine forretningskritiske tjenester BA28. Som API-konsument ønsker jeg informasjon om ytelsesmessige (svartid, antall oppslag) begrensninger i API-et, slik at jeg kan vurdere om API-et har god nok ytelse til mitt formål.
Som API-konsument ønsker jeg informasjon om kapasitet, ytelse og pålitelighet slik at jeg kan være sikker på at API-et kan benyttes i mine forretningskritiske tjenester BFP027: Som API-konsument ønsker jeg at dokumentasjonen til API-er jeg skal bruke har informasjon om kvalitet og tilgjengelighet, slik at jeg slipper mange henvendelser til API-tilbyder for å få svar på enkle ting.
Som API-forvalter ønsker jeg eierskapet og ansvaret til API-eier kommer tydlig frem slik at man unngår uklarheter BAM06 - Som ansvarlig for API-management ønsker jeg å kunne fordele eierskap og ansvar for de enkelte API-ene til det forretningsområdet som er dataforvalter/dataeier, slik at de kan være mest mulig selvbetjente og redusere flaskehalser (“publisher portal”)/sikre nærhet og dermed kvalitet (ansvarliggjøring av den rette aktøren)
Som API-forvalter ønsker jeg eierskapet og ansvaret til API-eier kommer tydlig frem slik at man unngår uklarheter BAM11 - Som ansvarlig for API-management ønsker jeg å sikre eierskap av API-ene hos forretningseier/dataeier for å sikre kvalitet og eierskap.
Som API-forvalter ønsker jeg eierskapet og ansvaret til API-eier kommer tydlig frem slik at man unngår uklarheter BAM18 - Som ansvarlig for flere datasett og medfølgende API’er ønsker jeg å ha kontroll på de datasettene forretningsenheten min tilbyr og enkelt gi tilgang til datasettene ved behov slik at jeg kan utføre ansvaret jeg har på en enkel måte
Som API-forvalter ønsker jeg eierskapet og ansvaret til API-eier kommer tydlig frem slik at man unngår uklarheter 27. Som API-katalogeier ønsker jeg å koordinere beskrivelsene av API-ene som inngår i min katalog, slik at beskrivelsene fremstår som ensartet for de som skal benytte API-ene.
Som API-forvalter ønsker jeg eierskapet og ansvaret til API-eier kommer tydlig frem slik at man unngår uklarheter BTI008 Som konsument av data fra offentlige virksomheter ønsker jeg at de offentlige virksomhetene inngår avtaler med sine leverandører som gjør det tydelig hvem som eier dataene, og stiller krav til at de skal være gjøres tilgjengelige uten kostnader, slik at ikke den offentlige virksomheten hindres i å dele sine data med meg som følge av at kostnadene blir for store.
Som API-konsument ønsker jeg kontaktinformasjon slik at man kan få hjelp BFP002: Som API-konsument ønsker jeg enhetlig dokumentasjon og mulighet til “kundeservice” fra tjenesteleverandør.
Som API-konsument ønsker jeg kontaktinformasjon slik at man kan få hjelp BFP011: Som API-konsument ønsker jeg et kontaktpunkt hos API-eier slik at man kan gi tilbakemelding og spørsmål.
Som API-konsument ønsker jeg å få tekstlig beskrivelse av et API slik at jeg kan forstå hvordan jeg skal bruke et API BFP009: Som API-konsument ønsker jeg å få dokumentere hvordan en kan oppdatere en egen kopi slik at en til hver tid bruker korrekte data.
Som API-konsuement ønsker jeg en tematisk oversikt over API slik at jeg lett kan finne fram 35. Som API-katalogeier ønsker jeg å kategorisere API-innslagene, slik at det kan differensieres mellom de.
Som API-konsuement ønsker jeg en tematisk oversikt over API slik at jeg lett kan finne fram BA32. Som API-konsument (gründer) ønsker jeg en tematisk oversikt over offentlige API slik at jeg kan lage nye tjenester.
Som API-konsument ønsker API-beskrivelsen refererer til begreper slik at jeg kan forstå innholdet i API-et BA5. Som API-konsument ønsker jeg at alle begreper linker direkte til en forklaring av begrepet slik at jeg slipper å lete gjennom dokumentasjonen. [kommentar: forskjell på begrep i den tekniske dokumentasjonen (f.eks. parameter i forespørsel) vs. begrep i datasettet (f.eks. fagtermer)]
Som API-konsument ønsker API-beskrivelsen refererer til begreper slik at jeg kan forstå innholdet i API-et BA39. Som API-konsument ønsker jeg at begreper i API-ene er dokumentert slik at jeg forstår dokumentasjonen og bruker dataene i API-ene rett.
Som API-konsument ønsker API-beskrivelsen refererer til begreper slik at jeg kan forstå innholdet i API-et BB6. Som API-konsument ønsker jeg at semantikken rundt dataene er forklart (dataene er definert), slik at jeg kan ta et informert valg om å bruke dataene fordi jeg forstår kontekst, formål og omfanget av dem. [dokumentasjon]
Som API-konsument ønsker API-beskrivelsen refererer til begreper slik at jeg kan forstå innholdet i API-et BFP019: Som API-konsument ønsker jeg at apiene inneholder referanser til begrepene som er brukt i apiene slik at jeg forstår detaljene og bruker dataene korrekt.
Som API-konsument ønsker jeg at API-beskrivelsen refererer til informasjonsmodeller slik at jeg forstår strukturen i API-ets respons BFP003: Som API-konsument ønsker jeg å kunne se eventuelt tilknyttede informasjonsmodeller der det finnes, slik at jeg også kan finne og kvalitetssikre data og informasjon.
Som API-konsument ønsker jeg at API-beskrivelsen refererer til informasjonsmodeller slik at jeg forstår strukturen i API-ets respons BB9. Som API-konsument (datajournalist) ønsker jeg å få forklaringer/dokumentasjon på hvordan dataene henger sammen slik at jeg kan spare tid på semantisk fortolkning (kobling mot datakatalogen?) [dokumentasjon]
Som API-konsument ønsker jeg referanser til brukte kodeverk slik at jeg kan forstå hvordan de skal fortolkes BFP018: Som API-konsument ønsker jeg at apiene inneholder referanser til lokale kodeverk som forklarer innholdet i apiene slik at jeg forstår detaljene i apiene.
Som API-konsument ønsker jeg referanser til brukte kodeverk slik at jeg kan forstå hvordan de skal fortolkes BA18. Som API-konsument ønsker jeg lenker til aktuelle kodeverk (f.eks. kommunenummer, næringskoder) slik at jeg lett kan hente støtte-datasett og dermed benytte datasettet fullt ut.
Som API-konsument ønsker jeg referanser til brukte kodeverk slik at jeg kan forstå hvordan de skal fortolkes BB16. Som API-konsument ønsker jeg at støttedatasett (f.eks. kodelister) er omtalt i dokumentasjonen slik at jeg kan anvende data fullt ut.[dokumentasjon]
Som API-konsument ønsker jeg informasjon om tilgang til dataene (tilgangsnivå) slik at jeg kan forstå hvordan jeg skal ta det i bruk BA29. Som API-konsument ønsker jeg informasjon om hvordan jeg kan skaffe meg tilgang til API-er som ikke er offentlig tilgjengelig. [Kommentar: manglar “slik at <forretningsverdi>”]
Som API-konsument ønsker jeg informasjon om tilgang til dataene (tilgangsnivå) slik at jeg kan forstå hvordan jeg skal ta det i bruk BB7. Som API-konsument ønsker jeg at det angis tydelig i dokumentasjonen hvilke data som er tilgjengelig, men også hva som ikke er tilgjengelig, slik at jeg slipper merarbeid pga. uklar dokumentasjon. [dokumentasjon]
Som API-forvalter ønssker jeg å beskrive kjente kvalitetsvurderinger slik at konsumenten kan forstå API-et bedre BA10.Som API-konsument ønsker jeg en indikasjon på hvor dynamisk datasettet er, slik at jeg har en idé om hvor ofte jeg trenger å lese data på nytt.
Som API-forvalter ønssker jeg å beskrive kjente kvalitetsvurderinger slik at konsumenten kan forstå API-et bedre BFP008: Som API-konsument ønsker jeg å vite oppdateringsfrekvens slik at jeg kan bestemme egen oppdatering.
Som API-forvalter ønssker jeg å beskrive kjente kvalitetsvurderinger slik at konsumenten kan forstå API-et bedre BFP020: Som API-konsument ønsker jeg informasjon om oppdateringsfrekvens av dataene eller om dataene er statiske.
Som API-konsument ønsker jeg å forstå om API-et tilbyr datamimimering slik at jeg kan understøtte godt personvern BFP025: Som API-konsument ønsker jeg å se hvilke muligheter det finnes for konfigurasjon både hos meg og hos API-leverandør for å begrense tilgjengelig data til mitt faktiske formål. Kommentar: Dataminimering?
Som API-konsument ønsker jeg å se eksempler på kall slik at jeg kan raskt sette meg inn i bruk av API-et BA4. Som API-konsument ønsker jeg eksempler på API-requests slik at jeg kan komme fort i gang.
Som API-konsument ønsker jeg å vite hva slags intereaksjonsform/type som API-et tilbyr slik at jeg kan vite om det dekker mine behov Som API-konsument ønsker jeg å vite hvilken interaksjonsform som tilbys i APIet (spørring, feed, fil) , slik at jeg kan vite om det dekker mine behov.
Som API-konsument ønsker jeg referanser til dokumentasjon som ikke beskrives i API-beskrivelsen slik at jeg kan nøste meg videre BA3. Som API-konsument ønsker jeg at det pekes til gode landingssider for API-et slik at jeg raskt settes i stand til å ta det i bruk.
Som API-konsument ønsker jeg referanser til dokumentasjon som ikke beskrives i API-beskrivelsen slik at jeg kan nøste meg videre BB15. Som API-konsument ønsker jeg at relevante opplysninger som ikke er tilgjengelig i API-et er omtalt i dokumentasjonen, slik at jeg kan bruke API-et riktig. [dokumentasjon]
Som API-konsument ønsker jeg referanser til dokumentasjon som ikke beskrives i API-beskrivelsen slik at jeg kan nøste meg videre BA22. Som API-konsument (app-utvikler) ønsker jeg en landingsside hvor jeg kan stille spørsmål om bruk av API-et slik at jeg kan bruke det mest mulig hensiktsmessig, og gjerne med henvisninger til kjent brukt av API-et.
Som API-konsument ønsker jeg referanser til dokumentasjon som ikke beskrives i API-beskrivelsen slik at jeg kan nøste meg videre BA23. Som API-konsument (app-utvikler) ønsker jeg en landingsside hvor jeg får tilgang til FAQ om API-et. [Kommentar: manglar “slik at <forretningsverdi>”]
Som API-konsument ønsker jeg oversikt over testmiljø og syntetiske data slik at jeg kan teste ut API-ene BFP016: Som API-konsument ønsker jeg en oversikt over hvilke versjoner som er tilgjengelig i hvilke miljø slik at jeg vet hva jeg kan teste mot. (prod og test)
Som API-konsument ønsker jeg oversikt over testmiljø og syntetiske data slik at jeg kan teste ut API-ene 8. Som API-forvalter som tilbyr data som ikke er åpne ønsker jeg å synliggjøre testmiljø for mine API-er slik at de er lette å oppdage for brukerne
Som API-konsument ønsker jeg oversikt over testmiljø og syntetiske data slik at jeg kan teste ut API-ene BFP013: Som API-konsument ønsker jeg en oversikt over tilgjengelige testmiljø for å teste ut apiene.
Som API-konsument ønsker jeg oversikt over testmiljø og syntetiske data slik at jeg kan teste ut API-ene BFP024: Som API-konsument ønsker jeg i de tilfeller hvor API er basert på et lukket datasett å koble meg til et miljø med syntetisk data for bruk i utvikling og test.
Som API-forvalter ønsker jeg at det med API-beskrivelsen følger en veileder slik at jeg kan følge beste praksis BA55. Som API-konsument, ønsker jeg at API-et er designet etter en felles “beste praksis” som gjelder for API-er i API-katalogen, slik at jeg lett kjenner meg igjen på tvers av API-ene i katalogen.
Som API-forvalter ønsker jeg at det med API-beskrivelsen følger en veileder slik at jeg kan følge beste praksis 6. Som API-forvalter ønsker jeg at de aktivitetene jeg må gjøre og de standardene jeg må forholde meg til for å gjøre API-dokumentasjonen tilgjengelig i en nasjonal API-katalog, også gir verdi for andre, kommersielle, internasjonale API-kataloger, f.eks. synliggjøring på søkemotorer, ref Schema.orgs arbeid med vokabular for WebAPI http://pending.webschemas.org/WebAPI
Som API-forvalter ønsker jeg at det med API-beskrivelsen følger en veileder slik at jeg kan følge beste praksis BAM02 - Som ansvarlig for API-management ønsker jeg å dokumentere mitt API slik at utviklere raskt kan benytte API-et for tilgang til de data API-et representerer
Som API-forvalter ønsker jeg at det med API-beskrivelsen følger en veileder slik at jeg kan følge beste praksis BA40. Som API-tilbyder* ønsker jeg retningslinjer og beste praksis for dokumentasjon av API-ene mine slik at jeg kan dokumentere så effektivt og bra som mulig.
EPOS 9: Som API-konsument ønsker jeg oversikt over hvem som bruker et API slik at jeg kan forstå det bedre BA14. Som API-konsument ønsker jeg lenker til applikasjoner som bruker datasettet, slik at jeg kan finne gode eksempler på bruk av API-et og datasettet. [kommentar: også programvarebibliotek og anna kodeverk som er relevant
EPOS 9: Som API-konsument ønsker jeg oversikt over hvem som bruker et API slik at jeg kan forstå det bedre BFP014: Som API-konsument ønsker jeg oversikt over tilgjengelige referanseimplementasjoner slik at jeg raskere kan komme i gang med å bruke apiene.
EPOS 9: Som API-konsument ønsker jeg oversikt over hvem som bruker et API slik at jeg kan forstå det bedre BB5. Som API-konsument ønsker jeg å få tilgang til eksempler på bruk av API-et slik at jeg kan se mulighetene for bruk og bedre forstå hva API-et er ment å brukes til. [dokumentasjon]
EPOS 9: Som API-konsument ønsker jeg oversikt over hvem som bruker et API slik at jeg kan forstå det bedre BFP022: Som API-konsument ønsker jeg eksempler/mal på bruk slik at jeg kan ta i bruk nye datasett raskest mulig.
EPOS 9: Som API-konsument ønsker jeg oversikt over hvem som bruker et API slik at jeg kan forstå det bedre 19. Som API-forvalter ønsker jeg kontaktinfo til de som bruker mine API slik at jeg kan ta kontakt med de om brukerundersøkelser, driftsmeldinger, endring av API, nye API og liknande. [dersom jeg ikke har egne løsninger for dette allerede]
Som API-konsument ønsker jeg informasjon om et API har varsligskanal slik at jeg kan fange opp endringer BA43. Som API-konsument ønsker jeg å bli varslet om at et API er “deprecated” (skal tas ut av bruk), slik at jeg kan oppdatere min applikasjon.
Som API-konsument ønsker jeg informasjon hvordan endringer i modell varsles slik at jeg kan fange opp endringer BFP030: Som API-konsument ønsker jeg å kunne spørre produsent om mer og bedre data slik at vi kan tilby et bedre og mer helhetlig bilde.
Som API-konsument ønsker jeg informasjon hvordan endringer i modell varsles slik at jeg kan fange opp endringer BFP017: Som API-konsument ønsker jeg en endringslogg så tidlig som mulig slik at jeg vet hva som har endret seg mellom versjoner.
Som API-konsument ønsker jeg å se relasjoner slik at jeg flere som tilbyr liknende API BTI010 Som API-tilbyder ønsker jeg å kunne se om andre tilbyr det samme eller nesten det samme som meg, så at det er mulig å harmonisere mellom “oss” [Livar: Case der det er fleire API-er som tilbyr det samme? Marit: Brreg og Skatt som har same datasett i FDK. Mathias: Felles studentsystem (FS) i UH-sektoren innheld personinformasjon. Kan ikkje konsoliderast med HR-data. Kan ikkje legge ned ein av dei. Dekker relasjonsfeltet i DCAT behovet?]
Som API-konsument ønsker jeg å forstå om API-et er tilrettelagt for bruk med brukers samtykke eller fullmakt Som sluttbruker ønsker jeg å gi samtykke til at en 3dje part kan innhente mine data fra offentlig myndighet slik at jeg slipper å tilgjengeliggjøre dataene selv
Som API-konsument ønsker jeg å forstå om API-et er tilrettelagt for bruk med brukers samtykke eller fullmakt Som sluttbruker ønsker jeg å gi samtykke til at en offentlig myndighet kan innhente mine data fra en 3dje part slik at jeg slipper å tilgjengegliggjøre dataene selv.
Som API-konsument ønsker jeg å forstå om API-et er tilrettelagt for bruk med brukers samtykke eller fullmakt Som sluttbruker ønsker jeg at en offentlig aktør skal ha tilgang til data om meg hos en annen offentlig aktør
Som API-konsument ønsker jeg å forstå om API-et er tilrettelagt for bruk med brukers samtykke eller fullmakt Som sluttbruker ønsker jeg at en privat virksomhet skal ha tilgang til data om meg fra en tredjepart (app) slik at jeg kan slippe å tiljgengeliggjøre dataene selv
Som API-konsument ønsker jeg at dokumentasjonen er genererert fra kode slik at jeg kan stole på at den er oppdatert BFP005: Som API-konsument ønsker jeg at dokumentasjonen skal integreres i koden slik at den til enhver tid er oppdatert
Som API-konsument ønsker jeg at dokumentasjonen er genererert fra kode slik at jeg kan stole på at den er oppdatert BA41. Som API-konsument som benytter verktøy for å generere deler av kildekoden ønsker jeg at API-et er dokumentert iht “Open API Specification”, slik at jeg kan bruke kodegenereringsverktøy for å generere mye av den kildekoden som trengs for å bruke API-et fremfor å måtte skrive den selv [ref epost]
Som API-konsument ønsker jeg at dokumentasjonen er genererert fra kode slik at jeg kan stole på at den er oppdatert 11. Som API-forvalter/eier ønsker jeg å generere dokumentasjon ut fra koden eller tester, slik at jeg er sikker på at dokumentasjonen til enhver tid er oppdatert.
Som API-konsument ønsker jeg at dokumentasjonen er genererert fra kode slik at jeg kan stole på at den er oppdatert BB18. Som API-konsument ønsker jeg at kildekoden til API-tjenesten er tilgjengelig som åpen kildekode, slik at jeg kan lese kildekode for å forstå APIet og kunne bruke det optimalt [dokumentasjon]
Som API-konsument ønsker jeg at det er gjort en sikkerhetsvurdering slik at krav til innebygd personvern er best mulig ivaretatt BFP001: Som API-forvalter ønsker jeg at det knyttes opplysninger om sikkerhetsvurderinger tilknyttet felt i API’et (identifiserende, lokaliserende, krav til sikring, osv.) slik at hensyn til innebygd personvern i større grad er ivaretatt for det datasettet som publiseres.
Som API-konsument ønsker jeg hjelp til tilgang til nøkler eller tokens for raskt å ta i bruk API-et BA2. Som API-konsument ønsker jeg umiddelbar tilgang (slipper å vente på manuell tildeling av API-nøkler og tokens) til data (eller testdata) slik at jeg kan vurdere og eventuelt ta i bruk API-et umiddelbart.
Som API-konsument ønsker jeg hjelp til tilgang til nøkler eller tokens for raskt å ta i bruk API-et BAM09 - Som ansvarlig for API-management ønsker jeg å kunne administrere nøkler gitt til de enkelte konsumentene slik at jeg enkelt kan fjerne ev. misbruk av API-et