Sykli uudelleenkaytettavien integraatiokyvykkyyksien tuotteistamiseen ennen toteutustavan valintaa.
Ohjaa uudelleenkaytettavan integraatiokyvykkyyden suunnittelua ennen API-, tapahtuma-, tiedosto-, virta-, datatuote-, suora integraatio- tai hybriditoteutustavan valintaa.
Reittisi kartalla
Metrokartta
Select a cycle, station, or stakeholder to open its permanent method page.
Selected station: Strategia
Tarvittavat sidosryhmät
Resources and canvases
Matkan kriteerit
Aloituskriteerit
Liiketoimintatavoitteet on määritelty.
Kyvykkyysmahdollisuus on tunnistettu ja dokumentoitu.
Valmistumiskriteerit
Valittu arkkitehtuuri, alusta ja toteutustapa on validoitu olennaisten arkkitehtuuri-, tietoturva- ja alustasidosryhmien kanssa.
Rajapinta ja sen kyvykkyydet on dokumentoitu riittävän selkeästi katselmointia, auditointia ja käyttöönottoa varten.
Ratkaisu läpäisee laatu-, tietoturva-, vaatimustenmukaisuus- ja valmiustarkastukset.
Kuvaa uudelleenkaytettava integraatiokyvykkyys, liiketoimintatarve, omistajuus ja odotettu uudelleenkaytto ennen toteutustavan valintaa.
Integraatio- ja API-työssä hypätään usein liian nopeasti tekniseen malliin. Tämä asema pitää tiimin keskittyneenä liiketoimintapolkuun, toimialan merkitykseen, arvoon, uudelleenkäyttöpotentiaaliin, omistajuuteen ja elinkelpoisuuteen ennen APIen, tapahtumien, tiedostojen, virtojen, datatuotteiden tai suoran integraation valintaa.
Suunnittele rajapintasopimus, skeemat, tietosisallot ja vuorovaikutusmallit valitulle integraatiotavalle.
Kun arkkitehtuurimalli on tiedossa, suunnittelun on muutettava kyvykkyysvaatimukset selkeiksi rajapintasopimuksiksi, vuorovaikutuksiksi, skeemoiksi, datasäännöiksi, elinkaariodotuksiksi ja hyödyntäjien velvoitteiksi.
Rakenna, testaa, automatisoi, julkaise ja operoi integraatiokyvykkyyttä sen valitulla toteutustavalla ja validoidulla rajapintasopimuksella.
Uudelleenkäytettävä kyvykkyys tarvitsee luotettavan toimituksen ja operoinnin riippumatta siitä, toteutuuko se APIlla, tapahtumavirtana, tiedostosiirtona, datatuotteena vai suorana integraationa.
Varmista integraation valmius, hallintamalli, laatu, tietoturva, vaatimustenmukaisuus ja operatiivinen näyttö ennen julkaisua.
Uudelleenkäytettävät kyvykkyydet luovat operatiivisia, dataan, tietoturvaan, tietosuojaan, vaatimustenmukaisuuteen ja hyödyntäjiin liittyviä riskejä. Valmiustarkastukset vähentävät yllätyksiä ennen julkaisua tai tuotantokäyttöä.
Julkaise integraatiokyvykkyys, jotta tiimit voivat loytaa sen, arvioida sen, pyytaa kayttooikeutta, suorittaa kayttoonoton, kayttaa sita uudelleen ja saada tukea.
Uudelleenkäytettävät kyvykkyydet tuottavat arvoa vain, kun hyödyntäjät löytävät ne, ymmärtävät rajapintasopimuksen ja palveluodotukset, voivat pyytää käyttöoikeutta ja tietävät, kuka omistaa tuen ja elinkaaripäätökset.
Seuraa integraation luotettavuutta, uudelleenkäyttöä, häiriöitä, suorituskykyä, hyödyntäjien tuloksia ja parannustarpeita.
Kyvykkyydet tarvitsevat jatkuvaa palautetta pysyäkseen luotettavina, arvokkaina, kustannustehokkaina ja uudelleenkäytettävinä, kun hyödyntäjät, järjestelmät, data ja alustat muuttuvat.
Publish this cycle
Export the page-specific template after reviewing the entity summary and supporting details above.
Confluence-vienti
Julkaisumallit
Use Markdown for repositories and static sites, or Confluence-wiki markup for compatible Confluence pages.
Markdown
# Integraatiokyvykkyyden tuotteistamisen sykli question template
Sykli uudelleenkaytettavien integraatiokyvykkyyksien tuotteistamiseen ennen toteutustavan valintaa.
Use this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.
## 1. Integraatiokyvykkyyden strategia
Kuvaa uudelleenkaytettava integraatiokyvykkyys, liiketoimintatarve, omistajuus ja odotettu uudelleenkaytto ennen toteutustavan valintaa.
### Canvas questions
#### Asiakaspolkukanvas
Mikä asiakkaan tai kumppanin polku synnyttää tarpeen kyvykkyydelle tai rajapinnalle?
- **Persona**: Kuka on tämän asiakaspolun kokija?
- **Asiakas havaitsee tarpeen**: Miten asiakas huomaa tarpeensa?
- **Tarve täyttyy**: Miten tarve lopulta täyttyy — mahdollisesti ilman APIa?
- **Asiakaspolun vaiheet**: Mitä vaiheita asiakas käy läpi?
- **Kipupisteet**: Mitkä haasteet tai ongelmat ilmenevät polun aikana?
- **Hyödyt**: Mitä hyötyä tai arvoa asiakas saa lopputuloksena?
- **Syötteet ja tulosteet**: Mitkä asiat käynnistävät ja seuraavat eri vaiheita?
- **Vuorovaikutus- ja käsittelysäännöt**: Mitkä roolit, järjestelmät tai säännöt vaikuttavat kulkuun?
#### Toimialuekanvas
Mitkä keskeiset käsitteet, entiteetit ja toimialueen säännöt kyvykkyyden tai rajapinnan täytyy huomioida?
- **Valitut asiakaspolun vaiheet**: Mitkä asiakaspolun vaiheet ovat olennaisia tälle toimialueelle?
- **Ydinkohteet ja liiketoiminnallinen merkitys**: Mitkä ovat keskeiset entiteetit ja niiden liiketoiminnallinen merkitys?
- **Attribuutit ja liiketoiminnallinen merkitys**: Mitkä ovat kunkin entiteetin keskeiset attribuutit ja niiden liiketoiminnallinen merkitys?
- **Entiteettien väliset suhteet**: Mitkä ovat entiteettien väliset suhteet?
- **Liiketoiminta-, sääntely- ja eheysvaatimukset**: Mitkä ovat entiteetteihin liittyvät liiketoiminta-, sääntely- ja eheysvaatimukset?
- **Tietoturva- ja yksityisyysnäkökohdat**: Mitä tietoturvaan ja yksityisyyteen liittyviä näkökulmia entiteetteihin liittyy?
#### Kyvykkyyden arvolupauskanvas
Mikä uudelleenkäytettävä kyvykkyys loisi arvoa hyödyntäjille ilman, että vielä päätetään toteutetaanko se API-rajapintana, tapahtumana, tiedostona, streamina, datatuotteena tai muuna integraatiotyylinä?
- **Hyödyntäjien tehtävät ja lopputulokset**: Mitä hyödyntäjät, kumppanit, käyttäjät, järjestelmät tai tiimit yrittävät saavuttaa?
- **Hyötyjä mahdollistavat kyvykkyyden ominaisuudet**: Mitkä kyvykkyyden ominaisuudet auttaisivat hyödyntäjiä saavuttamaan parempia tuloksia, nopeutta, automaatiota, oivalluksia, kattavuutta tai vaatimustenmukaisuutta?
- **Kipupisteitä vähentävät kyvykkyyden ominaisuudet**: Mitkä kyvykkyyden ominaisuudet poistaisivat kitkaa, manuaalista työtä, virheitä, viiveitä, riskejä tai epävarmuutta hyödyntäjiltä?
- **Uudelleenkäytettävät kyvykkyydet**: Mitkä uudelleenkäytettävät liiketoiminta- tai datakyvykkyydet voisivat palvella näitä tehtäviä, hyötyjä ja kipupisteitä useamman kuin yhden hyödyntäjän tai käyttötapauksen tarpeisiin?
#### Kyvykkyyden liiketoimintamallikanvas
Kuinka elinkelpoinen, uudelleenkäytettävä, rahoitettu, omistettu, tuettu ja löydettävä tämän integraatiokyvykkyyden tulisi olla?
- **Kyvykkyyden arvolupaus**: Mitä arvoa tämä uudelleenkäytettävä kyvykkyys tuottaa hyödyntäjille sekä organisaatiolle tai ekosysteemille?
- **Kyvykkyyden hyödyntäjäsegmentit**: Ketkä ovat kyvykkyyden nykyisiä ja mahdollisia hyödyntäjiä, mukaan lukien tiimit, kumppanit, järjestelmät, tuotteet tai datan käyttäjät?
- **Hyödyntäjien osallistaminen**: Miten hyödyntäjät löytävät, arvioivat, pyytävät käyttöönsä, ottavat käyttöön, saavat tukea ja antavat palautetta kyvykkyydestä?
- **Kanavat**: Minkä katalogien, portaalien, markkinapaikkojen, dokumentaatiosivustojen, tukikanavien tai governance-prosessien kautta hyödyntäjät ovat vuorovaikutuksessa kyvykkyyden kanssa?
- **Keskeiset resurssit**: Mitä järjestelmiä, data-aineistoja, alustoja, ihmisiä, standardeja, rahoitusta ja operatiivisia kyvykkyyksiä tarvitaan?
- **Keskeiset toiminnot**: Mitä kyvykkyyden omistajan ja tuottajien täytyy tehdä kyvykkyyden suunnittelemiseksi, toimittamiseksi, hallitsemiseksi, tukemiseksi ja parantamiseksi?
- **Keskeiset kumppanit**: Mitä liiketoiminnan, teknologian, datan, turvallisuuden, juridiikan, alustan tai ulkoisia kumppaneita tarvitaan, jotta kyvykkyys toimii?
- **Hyödyt**: Mitkä liiketoiminnalliset, operatiiviset, ekosysteemiin, uudelleenkäyttöön, vaatimustenmukaisuuteen tai kustannuksiin liittyvät hyödyt perustelevat kyvykkyyden?
- **Kustannukset**: Mitkä ovat kyvykkyyden rakentamisen, operoinnin, governancen, tuen ja kehittämisen merkittävät kustannukset?
## 2. Integraation hyödyntäjien vaatimukset ja käyttöönotto
Kokoa integraation hyödyntäjät, tuottajan vastuut, käyttöönoton tarpeet, palveluodotukset ja operatiiviset rajoitteet.
### Canvas questions
#### Hyödyntäjäkokemuksen vaatimuskanvas
Mitä kokemukseen liittyviä ja ei-toiminnallisia vaatimuksia hyödyntäjillä on ennen parhaan integraatioarkkitehtuurin valintaa?
- **Hyödyntäjien tavoitteet**: Mitkä ovat hyödyntäjien liiketoiminta-, työnkulku-, päätöksenteko-, automaatio- tai datankäyttötavoitteet?
- **Saatavuus ja ajantasaisuus**: Milloin kyvykkyyden täytyy olla saatavilla, kuinka ajantasaista tiedon täytyy olla ja millä latenssi- tai toimitusikkunoilla on merkitystä?
- **Volyymi ja suorituskyky**: Mitä pyyntö-, tapahtuma-, tietue-, tiedosto-, eräajo-, käyttäjä- tai transaktiovolyymeja kyvykkyyden täytyy tukea nyt ja myöhemmin?
- **Datan laatu ja yhdenmukaisuus**: Mitä tarkkuuteen, täydellisyyteen, yhdenmukaisuuteen, järjestykseen, deduplikointiin, täsmäytykseen tai validointiin liittyviä odotuksia hyödyntäjillä on?
- **Turvallisuus, tietosuoja ja vaatimustenmukaisuus**: Mitä identiteettiin, valtuutukseen, luottamuksellisuuteen, datan sijaintiin, suostumukseen, säilytykseen, auditointiin tai sääntelyyn liittyviä rajoitteita sovelletaan?
- **Käyttöönotto ja pääsy**: Miten hyödyntäjien tulisi löytää, pyytää, testata, saada hyväksyntä ja aloittaa kyvykkyyden käyttö?
- **Muutokset ja versiointi**: Kuinka paljon muutoksia hyödyntäjät sietävät ja mitä ennakkoilmoituksiin, yhteensopivuuteen, migraatioon tai versiointiin liittyviä odotuksia sovelletaan?
- **Havainnoitavuus ja tuki**: Mitä monitorointia, tilatietoa, jäljitettävyyttä, datan laadun näkyvyyttä, tukea, omistajuutta ja häiriöviestintää hyödyntäjät tarvitsevat?
- **Palautuminen ja jatkuvuus**: Mitä uudelleentoistoon, uudelleenyrityksiin, täsmäytykseen, varmuuskopiointiin, varamenettelyihin, jatkuvuuteen tai manuaaliseen palautumiseen liittyviä odotuksia täytyy tukea?
- **Arkkitehtuurivaikutukset**: Mitä nämä vaatimukset tarkoittavat mahdollisille arkkitehtuurityyleille, kuten API-rajapinnoille, tapahtumille, tiedostoille, streameille, datatuotteille tai suoralle integraatiolle?
### Other related resources
- **API-käyttöönoton parhaat käytännöt**: Parhaat käytännöt API-asiakkaiden käyttöönoton sujuvoittamiseksi vaiheittaisella rekisteröinnillä, tutustumisella ja ensisoitto-opastuksella.
## 3. Integraatioarkkitehtuuri ja alustapaatokset
Valitse integraatioarkkitehtuuri, toteutustapa ja alustakyvykkyydet huomioiden rajoitteet ja hallintamalli.
### Canvas questions
#### Liiketoimintavaikutuskanvas
Mitkä ovat kyvykkyyden tai rajapinnan epäonnistumisen mahdolliset liiketoimintavaikutukset?
- **Saatavuuteen liittyvät riskit**: Mitkä ovat APIn saatavuuteen liittyvät mahdolliset riskit?
- **Saatavuusriskien vähentäminen**: Miten API-tarjoaja voi vähentää saatavuuteen liittyviä riskejä?
- **Tietoturvariskit**: Mitkä ovat API-rajapintaan liittyvät mahdolliset tietoturvariskit?
- **Tietoturvariskien vähentäminen**: Miten API-tarjoaja voi vähentää tietoturvariskejä?
- **Tietoriskit**: Mitkä ovat mahdolliset riskit tiedon eheydelle tai luottamuksellisuudelle?
- **Tietoriskien vähentäminen**: Miten API-tarjoaja voi vähentää tietoriskejä?
#### Sijaintikanvas
Mitkä geopoliittiset, sääntelyyn liittyvät, verkko- ja luottamusrajat vaikuttavat tähän kyvykkyyteen tai rajapintaan?
- **Sijainti-/luottamusryhmät**: Mitkä ovat merkitykselliset geopoliittiset, sääntely-, verkko- tai luottamusryhmät?
- **Ryhmän ominaisuudet**: Mitkä ovat näiden ryhmien ominaisuudet, kuten sijainti, luottamustaso tai verkkoaltistuminen?
- **Merkittävät sijainnit / vyöhykkeet**: Mitkä ovat kunkin ryhmän merkittävät sijainnit, vyöhykkeet tai ympäristöt?
- **Sijainnin / vyöhykkeen ominaisuudet**: Mitkä ovat kyseisten sijaintien tai vyöhykkeiden ominaisuudet, kuten omistajuus, alue tai altistuminen?
- **Verkko- / sääntelyetäisyyde**: Mitä viive-, luottamus-, sääntely- tai yhteysetäisyyksiä sijaintien välillä on?
- **Etäisyyden ominaisuudet**: Mitkä ovat näiden etäisyyksien ominaisuudet, kuten viiveherkkyys, sijaintirajoitukset tai luottamusrajat?
- **Yhteyspäätepisteet**: Mitkä yhteyspäätepisteet tai rajapinnat liittyvät sijainteihin?
- **Päätepisteiden käyttöominaisuudet**: Mitkä ovat näiden päätepisteiden ominaisuudet, kuten altistuminen, protokolla, turvallisuus tai käyttörajoitukset?
#### Kapasiteettikanvas
Kuinka paljon kapasiteettia kyvykkyyden tai rajapinnan käytön tukeminen edellyttää?
- **Nykyinen liiketoimintavolyymi**: Mitkä ovat nykyiset liiketoimintavolyymit ja transaktiomäärät?
- **Tulevat kulutustrendit**: Mitkä ovat ennakoidut tulevat kulutustrendit?
- **Huipputehon ja saatavuuden vaatimukset**: Mitkä ovat huippukuormituksen ja saatavuuden vaatimukset?
- **Välimuististrategiat**: Mitä välimuististrategioita voidaan käyttää suorituskyvyn optimoimiseksi?
- **Kutsunopeuden rajoitusstrategiat**: Mitä kutsunopeuden rajoitusstrategioita voidaan käyttää kulutuksen hallintaan?
- **Skaalausstrategiat**: Mitä skaalausstrategioita voidaan käyttää kasvun tukemiseen?
### Other related resources
- **Kumppanien integrointiohjeet**: Integroinnin tarkistuslistat ja viestintämallit kolmannen osapuolen API-suhteiden teknisten ja oikeudellisten näkökohtien hallintaan.
## 4. Integraation ratkaisusuunnittelu
Suunnittele rajapintasopimus, skeemat, tietosisallot ja vuorovaikutusmallit valitulle integraatiotavalle.
### Canvas questions
#### Toimialuekanvas
Mitkä keskeiset käsitteet, entiteetit ja toimialueen säännöt kyvykkyyden tai rajapinnan täytyy huomioida?
- **Valitut asiakaspolun vaiheet**: Mitkä asiakaspolun vaiheet ovat olennaisia tälle toimialueelle?
- **Ydinkohteet ja liiketoiminnallinen merkitys**: Mitkä ovat keskeiset entiteetit ja niiden liiketoiminnallinen merkitys?
- **Attribuutit ja liiketoiminnallinen merkitys**: Mitkä ovat kunkin entiteetin keskeiset attribuutit ja niiden liiketoiminnallinen merkitys?
- **Entiteettien väliset suhteet**: Mitkä ovat entiteettien väliset suhteet?
- **Liiketoiminta-, sääntely- ja eheysvaatimukset**: Mitkä ovat entiteetteihin liittyvät liiketoiminta-, sääntely- ja eheysvaatimukset?
- **Tietoturva- ja yksityisyysnäkökohdat**: Mitä tietoturvaan ja yksityisyyteen liittyviä näkökulmia entiteetteihin liittyy?
#### Vuorovaikutuskanvas
Minkä tyyppisiä vuorovaikutuksia kyvykkyyden tai rajapinnan täytyy tukea ennen protokollakohtaisen suunnittelun valintaa?
- **CRUD-vuorovaikutukset**: Tarvitaanko CRUD (luo, lue, päivitä, poista) -tyylisiä vuorovaikutuksia?
- **CRUD-syötteet ja vastaukset**: Mitkä ovat CRUD-vuorovaikutusten syötteet ja vastaukset, jos tätä tyyliä tarvitaan?
- **CRUD-käsittely ja validointi**: Mitkä ovat CRUD-vuorovaikutusten käsittely- ja validointisäännöt, jos tätä tyyliä tarvitaan?
- **Kyselyohjatut vuorovaikutukset**: Mitä luku- tai kyselyvuorovaikutuksia tarvitaan vastaamaan hyödyntäjien kysymyksiin?
- **Kyselyohjatut syötteet ja vastaukset**: Mitkä ovat kyselyohjattujen vuorovaikutusten syötteet ja vastaukset?
- **Kyselyohjatut käsittely- ja validointisäännöt**: Mitkä ovat kyselyohjattujen vuorovaikutusten käsittely- ja validointisäännöt?
- **Komento-ohjatut vuorovaikutukset**: Mitä tilaa muuttavia komentoja tarvitaan, jos niitä tarvitaan?
- **Komento-ohjatut syötteet ja vastaukset**: Mitkä ovat komento-ohjattujen vuorovaikutusten syötteet ja vastaukset, jos tätä tyyliä tarvitaan?
- **Komento-ohjattu käsittely ja validointi**: Mitkä ovat komento-ohjattujen vuorovaikutusten käsittely- ja validointisäännöt, jos tätä tyyliä tarvitaan?
- **Tapahtumapohjaiset vuorovaikutukset**: Mitkä tapahtumat on julkaistava tai hyödynnettävä, jos sellaisia on?
- **Tapahtumapohjaiset syötteet ja vasstaukset**: Mitkä ovat tapahtumapohjaisten vuorovaikutusten syötteet ja vastaukset, jos tätä tyyliä tarvitaan?
- **Tapahtumapohjainen käsittely ja validointi**: Mitkä ovat tapahtumapohjaisten vuorovaikutusten käsittely- ja validointisäännöt, jos tätä tyyliä tarvitaan?
#### REST-kanvas
Miten API voidaan suunnitella REST-periaatteiden mukaisesti?
- **APIn resurssit**: Mitkä ovat keskeiset resurssit, joita API paljastaa?
- **APIn resurssimalli**: Millainen on APIn resurssimallin rakenne?
- **APIn verbit**: Mitä HTTP-verbejä käytetään APIn resurssien kanssa vuorovaikutuksessa?
- **API-verbin esimerkki**: Anna esimerkki API-pyynnöstä ja -vastauksesta kullekin verbille.
#### Tapahtumakanvas
Mitkä tapahtumat ovat olennaisia kyvykkyydelle tai rajapinnalle ja miten ne käsitellään?
- **Käyttäjän tehtävä / Laukaisija**: Mikä käyttäjän toiminto tai järjestelmätapahtuma laukaisee tämän tapahtuman?
- **Syöte / Tapahtumakuorma**: Mitä tietoja saapuva tapahtumakuorma sisältää? Määrittele keskeiset attribuutit.
- **Käsittely / Logiikka**: Kuvaile taustajärjestelmän käsittelylogiikka mukaan lukien validoinnit, muunnokset ja reitityspäätökset.
- **Tulos / Tapahtuman lopputulos**: Mikä tapahtuma tai kuittaus syntyy? Sisällytä vastauksen attribuutit.
#### GraphQL-kanvas
Miten API voidaan suunnitella GraphQL-periaatteiden mukaisesti?
- **APIn nimi**: Mikä on GraphQL-API:n tai päätepisteen nimi?
- **Käyttäjien tavoitteet**: Mitä ongelmia API:n käyttäjät yrittävät ratkaista? Mitä dataa he tarvitsevat?
- **Keskeiset tyypit**: Mitkä ovat keskeiset tyypit (esim. User, Order, Product)?
- **Suhteet**: Miten tyypit liittyvät toisiinsa sisäkkäisissä kyselyissä?
- **Kyselyt**: Mitä yleisiä kyselyitä pitäisi tukea?
- **Mutaatiot**: Mitkä toiminnot muuttavat dataa (esim. luonti, päivitys, poisto)?
- **Tilaukset**: Onko reaaliaikaisia päivityksiä tai tapahtumia, joita voi tilata?
- **Valtuutussäännöt**: Kuka voi käyttää mitäkin kenttiä tai tyyppejä?
- **Käyttäjärajoitukset**: Onko sivutukseen, suodatukseen tai nopeusrajoihin liittyviä rajoitteita?
- **Huomiot / Avoimet kysymykset**: Onko keskeneräisiä päätöksiä tai integraatioon liittyviä huomioita?
### Other related resources
- **Integraatiotavan valintaopas**: Ohje API-, tapahtuma-, tiedosto-, tietovirta-, datatuote-, suora integraatio- tai hybriditoteutustavan valintaan vaatimusten ja rajoitteiden perusteella.
- **Sopimuslähtöinen suunnittelu**: Suuntaviiva, jossa kannatetaan API-lähestymistapaa, jossa käytetään virallisia sopimuksia (esim. OpenAPI) sidosryhmien yhdenmukaistamiseksi ennen kehitystä.
## 5. Integraation toimitus ja operointi
Rakenna, testaa, automatisoi, julkaise ja operoi integraatiokyvykkyyttä sen valitulla toteutustavalla ja validoidulla rajapintasopimuksella.
### Station questions
- Käytä kehityksen parhaita käytäntöjä validoidun rajapintasopimuksen toteuttamiseen vakiintuneilla kehyksillä, kirjastoilla ja tiimin standardeilla.
- Rakenna toteutus validoidun rajapintasopimuksen pohjalta vakiintuneilla kehyksillä, kirjastoilla ja tiimin standardeilla.
- Käytä testausohjeistusta toiminnallisuuden, datan laadun, yhteensopivuuden, tietoturvan, suorituskyvyn, resilienssin ja palautumisodotusten varmistamiseen.
- Käytä CI/CD-ohjeistusta koonnin, testauksen, julkaisun, konfiguraation ja jäljitettävyyden automatisointiin.
- Käytä tietoturvaohjeistusta datan, käyttöoikeuksien, tunnistetietojen ja alustarajojen suojaamiseen.
- Käytä auditoinnin tarkistuslistaa varmistaaksesi, että ratkaisu täyttää toiminnalliset ja ei-toiminnalliset vaatimukset, mukaan lukien tietoturva, suorituskyky ja vaatimustenmukaisuus.
- Sovella toimituksen, testauksen, CI/CD:n, operoinnin ja tietoturvan ohjeistusta valittuun toteutustapaan.
- Uudelleenkäytettävä kyvykkyys tarvitsee luotettavan toimituksen ja operoinnin riippumatta siitä, toteutuuko se APIlla, tapahtumavirtana, tiedostosiirtona, datatuotteena vai suorana integraationa.
### Other related resources
- **API-kehityksen parhaat käytännöt**: Toteutusohje, jonka avulla validoitu API-rajapintasopimus muutetaan johdonmukaiseksi ja ylläpidettäväksi API-koodipohjaksi vakiokirjastojen, uudelleenkäytettävien mallien ja yhteensovitettujen kehitystyönkulkujen avulla.
- **API-testauksen parhaat käytännöt**: Ohjeet automatisoidun toiminnallisen, suorituskyky- ja tietoturvatestauksen toteuttamiseksi koko rajapinnan elinkaaren ajan.
- **APIOps CI/CD rajapinnoille**: Käyttöönotto-ohjeet, jotka integroivat APIn elinkaaren tehtävät - suunnittelun, testauksen ja hallinnan - jatkuvaan integrointiin ja toimitusputkiin.
- **API-turvallisuuden parhaat käytännöt**: Joukko toimivia valvontatoimia rajapintojen suojaamiseksi, mukaan lukien todennus, valtuutus, salaus, nopeuden rajoittaminen ja putkitason vaatimustenmukaisuustarkastukset.
- **Kumppanien integrointiohjeet**: Integroinnin tarkistuslistat ja viestintämallit kolmannen osapuolen API-suhteiden teknisten ja oikeudellisten näkökohtien hallintaan.
## 6. Integraation valmiuden varmistus
Varmista integraation valmius, hallintamalli, laatu, tietoturva, vaatimustenmukaisuus ja operatiivinen näyttö ennen julkaisua.
### Station questions
- Käytä auditoinnin tarkistuslistaa uudelleenkäytettävänä laatutarkistuslistana rajapintasopimuksen, dokumentaation, tietoturvan, suorituskyvyn ja vaatimustenmukaisuuden valmiudelle.
- Käytä tarkistuslistoja, linttereitä ja testausvälineitä johdonmukaisuuden ja standardien noudattamisen varmistamiseen.
- Tee yhteistyötä hallintatiimien ja toimialan asiantuntijoiden kanssa varmistaaksesi, että kyvykkyys on valmis tuotantoon.
- Käytä auditointi- ja vaatimustenmukaisuusresursseja varmistaaksesi, että kyvykkyys on valmis hallittuun julkaisuun ja uudelleenkäyttöön.
- Uudelleenkäytettävät kyvykkyydet luovat operatiivisia, dataan, tietoturvaan, tietosuojaan, vaatimustenmukaisuuteen ja hyödyntäjiin liittyviä riskejä. Valmiustarkastukset vähentävät yllätyksiä ennen julkaisua tai tuotantokäyttöä.
### Other related resources
- **API-auditoinnin tarkistuslista**: Elinkaaripohjainen tarkistuslista, jolla varmistetaan APIn valmius suunnittelun, toimituksen, julkaisun ja vaatimustenmukaisuuden osalta määriteltyjen auditointikriteerien ja todisteiden avulla.
- **API-vaatimustenmukaisuuden parhaat käytännöt**: Varmista, että rajapinnat täyttävät oikeudelliset, sääntelyyn liittyvät ja sisäiset vaatimukset dokumentoinnin, valvonnan ja automaattisten validointien avulla.
## 7. Integraation julkaisu ja kayttoonoton tuki
Julkaise integraatiokyvykkyys, jotta tiimit voivat loytaa sen, arvioida sen, pyytaa kayttooikeutta, suorittaa kayttoonoton, kayttaa sita uudelleen ja saada tukea.
### Station questions
- Julkaise kyvykkyyden tiedot asianmukaisiin katalogeihin, portaaleihin, yhdyskäytäviin tai ympäristöihin, jotta useat hyödyntäjät voivat käyttää sitä uudelleen.
- Dokumentoi, miten hyödyntäjät löytävät kyvykkyyden ja käyttävät sitä, mukaan lukien käyttöönotto- ja rekisteröintiprosessit.
- Varmista, että tietoturvamallit, käyttöoikeuskonfiguraatio ja oikeudelliset ehdot ovat selkeitä ja hyödyntäjien saatavilla.
- Julkaise omistajuus, dokumentaatio, käyttöönotto, tukiyhteystiedot, palveluodotukset, elinkaaren tila ja käyttöoikeuspyyntöjen polut.
- Uudelleenkäytettävät kyvykkyydet tuottavat arvoa vain, kun hyödyntäjät löytävät ne, ymmärtävät rajapintasopimuksen ja palveluodotukset, voivat pyytää käyttöoikeutta ja tietävät, kuka omistaa tuen ja elinkaaripäätökset.
### Other related resources
- **API-käyttöönoton parhaat käytännöt**: Parhaat käytännöt API-asiakkaiden käyttöönoton sujuvoittamiseksi vaiheittaisella rekisteröinnillä, tutustumisella ja ensisoitto-opastuksella.
- **Palvelusopimusmalli**: Mukautettava sopimusmuoto, jossa määritellään odotukset, SLA:t, vastuut ja käyttöoikeusehdot API-käyttöä varten.
## 8. Integraation seuranta ja parantaminen
Seuraa integraation luotettavuutta, uudelleenkäyttöä, häiriöitä, suorituskykyä, hyödyntäjien tuloksia ja parannustarpeita.
### Station questions
- Käytä mittari- ja analytiikkaohjeistusta kyvykkyyden käytön, luotettavuuden, datan laadun, kustannusten, käyttöönoton ja hyödyntäjäarvon mittareiden määrittelyyn.
- Analysoi käyttömittareita ja ota hyödyntäjien palaute mukaan kyvykkyyden kehitysversioihin.
- Luo tapa tarkastella mittareita ja suunnitella jatkuvan parantamisen toimia.
- Käytä mittareita, analytiikkaa ja osallistamisen käytäntöjä kyvykkyyden jatkuvaan parantamiseen.
- Kyvykkyydet tarvitsevat jatkuvaa palautetta pysyäkseen luotettavina, arvokkaina, kustannustehokkaina ja uudelleenkäytettävinä, kun hyödyntäjät, järjestelmät, data ja alustat muuttuvat.
### Other related resources
- **API-mittarit ja analytiikka**: Resurssi API-suorituskyvyn ja käyttötietojen määrittelyyn, keräämiseen ja analysointiin, jotta tekniset KPI:t voidaan sovittaa yhteen liiketoiminnan tulosten kanssa.
- **API-yhteisön sitouttamisstrategiat**: Toimintakirja API-käyttöliittymien käyttöönoton edistämiseksi kehittämällä yhteisöjä sisällön, tukikanavien, palautesilmukoiden ja sosiaalisen sitoutumisen strategioiden avulla.
Confluence-wiki
h1. Integraatiokyvykkyyden tuotteistamisen sykli question template
Sykli uudelleenkaytettavien integraatiokyvykkyyksien tuotteistamiseen ennen toteutustavan valintaa.
Use this template to gather answers and evidence station by station. Canvas section prompts are listed first, followed by other related resources.
h2. 1. Integraatiokyvykkyyden strategia
Kuvaa uudelleenkaytettava integraatiokyvykkyys, liiketoimintatarve, omistajuus ja odotettu uudelleenkaytto ennen toteutustavan valintaa.
h3. Canvas questions
#### Asiakaspolkukanvas
Mikä asiakkaan tai kumppanin polku synnyttää tarpeen kyvykkyydelle tai rajapinnalle?
* *Persona*: Kuka on tämän asiakaspolun kokija?
* *Asiakas havaitsee tarpeen*: Miten asiakas huomaa tarpeensa?
* *Tarve täyttyy*: Miten tarve lopulta täyttyy — mahdollisesti ilman APIa?
* *Asiakaspolun vaiheet*: Mitä vaiheita asiakas käy läpi?
* *Kipupisteet*: Mitkä haasteet tai ongelmat ilmenevät polun aikana?
* *Hyödyt*: Mitä hyötyä tai arvoa asiakas saa lopputuloksena?
* *Syötteet ja tulosteet*: Mitkä asiat käynnistävät ja seuraavat eri vaiheita?
* *Vuorovaikutus- ja käsittelysäännöt*: Mitkä roolit, järjestelmät tai säännöt vaikuttavat kulkuun?
#### Toimialuekanvas
Mitkä keskeiset käsitteet, entiteetit ja toimialueen säännöt kyvykkyyden tai rajapinnan täytyy huomioida?
* *Valitut asiakaspolun vaiheet*: Mitkä asiakaspolun vaiheet ovat olennaisia tälle toimialueelle?
* *Ydinkohteet ja liiketoiminnallinen merkitys*: Mitkä ovat keskeiset entiteetit ja niiden liiketoiminnallinen merkitys?
* *Attribuutit ja liiketoiminnallinen merkitys*: Mitkä ovat kunkin entiteetin keskeiset attribuutit ja niiden liiketoiminnallinen merkitys?
* *Entiteettien väliset suhteet*: Mitkä ovat entiteettien väliset suhteet?
* *Liiketoiminta-, sääntely- ja eheysvaatimukset*: Mitkä ovat entiteetteihin liittyvät liiketoiminta-, sääntely- ja eheysvaatimukset?
* *Tietoturva- ja yksityisyysnäkökohdat*: Mitä tietoturvaan ja yksityisyyteen liittyviä näkökulmia entiteetteihin liittyy?
#### Kyvykkyyden arvolupauskanvas
Mikä uudelleenkäytettävä kyvykkyys loisi arvoa hyödyntäjille ilman, että vielä päätetään toteutetaanko se API-rajapintana, tapahtumana, tiedostona, streamina, datatuotteena tai muuna integraatiotyylinä?
* *Hyödyntäjien tehtävät ja lopputulokset*: Mitä hyödyntäjät, kumppanit, käyttäjät, järjestelmät tai tiimit yrittävät saavuttaa?
* *Hyötyjä mahdollistavat kyvykkyyden ominaisuudet*: Mitkä kyvykkyyden ominaisuudet auttaisivat hyödyntäjiä saavuttamaan parempia tuloksia, nopeutta, automaatiota, oivalluksia, kattavuutta tai vaatimustenmukaisuutta?
* *Kipupisteitä vähentävät kyvykkyyden ominaisuudet*: Mitkä kyvykkyyden ominaisuudet poistaisivat kitkaa, manuaalista työtä, virheitä, viiveitä, riskejä tai epävarmuutta hyödyntäjiltä?
* *Uudelleenkäytettävät kyvykkyydet*: Mitkä uudelleenkäytettävät liiketoiminta- tai datakyvykkyydet voisivat palvella näitä tehtäviä, hyötyjä ja kipupisteitä useamman kuin yhden hyödyntäjän tai käyttötapauksen tarpeisiin?
#### Kyvykkyyden liiketoimintamallikanvas
Kuinka elinkelpoinen, uudelleenkäytettävä, rahoitettu, omistettu, tuettu ja löydettävä tämän integraatiokyvykkyyden tulisi olla?
* *Kyvykkyyden arvolupaus*: Mitä arvoa tämä uudelleenkäytettävä kyvykkyys tuottaa hyödyntäjille sekä organisaatiolle tai ekosysteemille?
* *Kyvykkyyden hyödyntäjäsegmentit*: Ketkä ovat kyvykkyyden nykyisiä ja mahdollisia hyödyntäjiä, mukaan lukien tiimit, kumppanit, järjestelmät, tuotteet tai datan käyttäjät?
* *Hyödyntäjien osallistaminen*: Miten hyödyntäjät löytävät, arvioivat, pyytävät käyttöönsä, ottavat käyttöön, saavat tukea ja antavat palautetta kyvykkyydestä?
* *Kanavat*: Minkä katalogien, portaalien, markkinapaikkojen, dokumentaatiosivustojen, tukikanavien tai governance-prosessien kautta hyödyntäjät ovat vuorovaikutuksessa kyvykkyyden kanssa?
* *Keskeiset resurssit*: Mitä järjestelmiä, data-aineistoja, alustoja, ihmisiä, standardeja, rahoitusta ja operatiivisia kyvykkyyksiä tarvitaan?
* *Keskeiset toiminnot*: Mitä kyvykkyyden omistajan ja tuottajien täytyy tehdä kyvykkyyden suunnittelemiseksi, toimittamiseksi, hallitsemiseksi, tukemiseksi ja parantamiseksi?
* *Keskeiset kumppanit*: Mitä liiketoiminnan, teknologian, datan, turvallisuuden, juridiikan, alustan tai ulkoisia kumppaneita tarvitaan, jotta kyvykkyys toimii?
* *Hyödyt*: Mitkä liiketoiminnalliset, operatiiviset, ekosysteemiin, uudelleenkäyttöön, vaatimustenmukaisuuteen tai kustannuksiin liittyvät hyödyt perustelevat kyvykkyyden?
* *Kustannukset*: Mitkä ovat kyvykkyyden rakentamisen, operoinnin, governancen, tuen ja kehittämisen merkittävät kustannukset?
h2. 2. Integraation hyödyntäjien vaatimukset ja käyttöönotto
Kokoa integraation hyödyntäjät, tuottajan vastuut, käyttöönoton tarpeet, palveluodotukset ja operatiiviset rajoitteet.
h3. Canvas questions
#### Hyödyntäjäkokemuksen vaatimuskanvas
Mitä kokemukseen liittyviä ja ei-toiminnallisia vaatimuksia hyödyntäjillä on ennen parhaan integraatioarkkitehtuurin valintaa?
* *Hyödyntäjien tavoitteet*: Mitkä ovat hyödyntäjien liiketoiminta-, työnkulku-, päätöksenteko-, automaatio- tai datankäyttötavoitteet?
* *Saatavuus ja ajantasaisuus*: Milloin kyvykkyyden täytyy olla saatavilla, kuinka ajantasaista tiedon täytyy olla ja millä latenssi- tai toimitusikkunoilla on merkitystä?
* *Volyymi ja suorituskyky*: Mitä pyyntö-, tapahtuma-, tietue-, tiedosto-, eräajo-, käyttäjä- tai transaktiovolyymeja kyvykkyyden täytyy tukea nyt ja myöhemmin?
* *Datan laatu ja yhdenmukaisuus*: Mitä tarkkuuteen, täydellisyyteen, yhdenmukaisuuteen, järjestykseen, deduplikointiin, täsmäytykseen tai validointiin liittyviä odotuksia hyödyntäjillä on?
* *Turvallisuus, tietosuoja ja vaatimustenmukaisuus*: Mitä identiteettiin, valtuutukseen, luottamuksellisuuteen, datan sijaintiin, suostumukseen, säilytykseen, auditointiin tai sääntelyyn liittyviä rajoitteita sovelletaan?
* *Käyttöönotto ja pääsy*: Miten hyödyntäjien tulisi löytää, pyytää, testata, saada hyväksyntä ja aloittaa kyvykkyyden käyttö?
* *Muutokset ja versiointi*: Kuinka paljon muutoksia hyödyntäjät sietävät ja mitä ennakkoilmoituksiin, yhteensopivuuteen, migraatioon tai versiointiin liittyviä odotuksia sovelletaan?
* *Havainnoitavuus ja tuki*: Mitä monitorointia, tilatietoa, jäljitettävyyttä, datan laadun näkyvyyttä, tukea, omistajuutta ja häiriöviestintää hyödyntäjät tarvitsevat?
* *Palautuminen ja jatkuvuus*: Mitä uudelleentoistoon, uudelleenyrityksiin, täsmäytykseen, varmuuskopiointiin, varamenettelyihin, jatkuvuuteen tai manuaaliseen palautumiseen liittyviä odotuksia täytyy tukea?
* *Arkkitehtuurivaikutukset*: Mitä nämä vaatimukset tarkoittavat mahdollisille arkkitehtuurityyleille, kuten API-rajapinnoille, tapahtumille, tiedostoille, streameille, datatuotteille tai suoralle integraatiolle?
h3. Other related resources
* *API-käyttöönoton parhaat käytännöt*: Parhaat käytännöt API-asiakkaiden käyttöönoton sujuvoittamiseksi vaiheittaisella rekisteröinnillä, tutustumisella ja ensisoitto-opastuksella.
h2. 3. Integraatioarkkitehtuuri ja alustapaatokset
Valitse integraatioarkkitehtuuri, toteutustapa ja alustakyvykkyydet huomioiden rajoitteet ja hallintamalli.
h3. Canvas questions
#### Liiketoimintavaikutuskanvas
Mitkä ovat kyvykkyyden tai rajapinnan epäonnistumisen mahdolliset liiketoimintavaikutukset?
* *Saatavuuteen liittyvät riskit*: Mitkä ovat APIn saatavuuteen liittyvät mahdolliset riskit?
* *Saatavuusriskien vähentäminen*: Miten API-tarjoaja voi vähentää saatavuuteen liittyviä riskejä?
* *Tietoturvariskit*: Mitkä ovat API-rajapintaan liittyvät mahdolliset tietoturvariskit?
* *Tietoturvariskien vähentäminen*: Miten API-tarjoaja voi vähentää tietoturvariskejä?
* *Tietoriskit*: Mitkä ovat mahdolliset riskit tiedon eheydelle tai luottamuksellisuudelle?
* *Tietoriskien vähentäminen*: Miten API-tarjoaja voi vähentää tietoriskejä?
#### Sijaintikanvas
Mitkä geopoliittiset, sääntelyyn liittyvät, verkko- ja luottamusrajat vaikuttavat tähän kyvykkyyteen tai rajapintaan?
* *Sijainti-/luottamusryhmät*: Mitkä ovat merkitykselliset geopoliittiset, sääntely-, verkko- tai luottamusryhmät?
* *Ryhmän ominaisuudet*: Mitkä ovat näiden ryhmien ominaisuudet, kuten sijainti, luottamustaso tai verkkoaltistuminen?
* *Merkittävät sijainnit / vyöhykkeet*: Mitkä ovat kunkin ryhmän merkittävät sijainnit, vyöhykkeet tai ympäristöt?
* *Sijainnin / vyöhykkeen ominaisuudet*: Mitkä ovat kyseisten sijaintien tai vyöhykkeiden ominaisuudet, kuten omistajuus, alue tai altistuminen?
* *Verkko- / sääntelyetäisyyde*: Mitä viive-, luottamus-, sääntely- tai yhteysetäisyyksiä sijaintien välillä on?
* *Etäisyyden ominaisuudet*: Mitkä ovat näiden etäisyyksien ominaisuudet, kuten viiveherkkyys, sijaintirajoitukset tai luottamusrajat?
* *Yhteyspäätepisteet*: Mitkä yhteyspäätepisteet tai rajapinnat liittyvät sijainteihin?
* *Päätepisteiden käyttöominaisuudet*: Mitkä ovat näiden päätepisteiden ominaisuudet, kuten altistuminen, protokolla, turvallisuus tai käyttörajoitukset?
#### Kapasiteettikanvas
Kuinka paljon kapasiteettia kyvykkyyden tai rajapinnan käytön tukeminen edellyttää?
* *Nykyinen liiketoimintavolyymi*: Mitkä ovat nykyiset liiketoimintavolyymit ja transaktiomäärät?
* *Tulevat kulutustrendit*: Mitkä ovat ennakoidut tulevat kulutustrendit?
* *Huipputehon ja saatavuuden vaatimukset*: Mitkä ovat huippukuormituksen ja saatavuuden vaatimukset?
* *Välimuististrategiat*: Mitä välimuististrategioita voidaan käyttää suorituskyvyn optimoimiseksi?
* *Kutsunopeuden rajoitusstrategiat*: Mitä kutsunopeuden rajoitusstrategioita voidaan käyttää kulutuksen hallintaan?
* *Skaalausstrategiat*: Mitä skaalausstrategioita voidaan käyttää kasvun tukemiseen?
h3. Other related resources
* *Kumppanien integrointiohjeet*: Integroinnin tarkistuslistat ja viestintämallit kolmannen osapuolen API-suhteiden teknisten ja oikeudellisten näkökohtien hallintaan.
h2. 4. Integraation ratkaisusuunnittelu
Suunnittele rajapintasopimus, skeemat, tietosisallot ja vuorovaikutusmallit valitulle integraatiotavalle.
h3. Canvas questions
#### Toimialuekanvas
Mitkä keskeiset käsitteet, entiteetit ja toimialueen säännöt kyvykkyyden tai rajapinnan täytyy huomioida?
* *Valitut asiakaspolun vaiheet*: Mitkä asiakaspolun vaiheet ovat olennaisia tälle toimialueelle?
* *Ydinkohteet ja liiketoiminnallinen merkitys*: Mitkä ovat keskeiset entiteetit ja niiden liiketoiminnallinen merkitys?
* *Attribuutit ja liiketoiminnallinen merkitys*: Mitkä ovat kunkin entiteetin keskeiset attribuutit ja niiden liiketoiminnallinen merkitys?
* *Entiteettien väliset suhteet*: Mitkä ovat entiteettien väliset suhteet?
* *Liiketoiminta-, sääntely- ja eheysvaatimukset*: Mitkä ovat entiteetteihin liittyvät liiketoiminta-, sääntely- ja eheysvaatimukset?
* *Tietoturva- ja yksityisyysnäkökohdat*: Mitä tietoturvaan ja yksityisyyteen liittyviä näkökulmia entiteetteihin liittyy?
#### Vuorovaikutuskanvas
Minkä tyyppisiä vuorovaikutuksia kyvykkyyden tai rajapinnan täytyy tukea ennen protokollakohtaisen suunnittelun valintaa?
* *CRUD-vuorovaikutukset*: Tarvitaanko CRUD (luo, lue, päivitä, poista) -tyylisiä vuorovaikutuksia?
* *CRUD-syötteet ja vastaukset*: Mitkä ovat CRUD-vuorovaikutusten syötteet ja vastaukset, jos tätä tyyliä tarvitaan?
* *CRUD-käsittely ja validointi*: Mitkä ovat CRUD-vuorovaikutusten käsittely- ja validointisäännöt, jos tätä tyyliä tarvitaan?
* *Kyselyohjatut vuorovaikutukset*: Mitä luku- tai kyselyvuorovaikutuksia tarvitaan vastaamaan hyödyntäjien kysymyksiin?
* *Kyselyohjatut syötteet ja vastaukset*: Mitkä ovat kyselyohjattujen vuorovaikutusten syötteet ja vastaukset?
* *Kyselyohjatut käsittely- ja validointisäännöt*: Mitkä ovat kyselyohjattujen vuorovaikutusten käsittely- ja validointisäännöt?
* *Komento-ohjatut vuorovaikutukset*: Mitä tilaa muuttavia komentoja tarvitaan, jos niitä tarvitaan?
* *Komento-ohjatut syötteet ja vastaukset*: Mitkä ovat komento-ohjattujen vuorovaikutusten syötteet ja vastaukset, jos tätä tyyliä tarvitaan?
* *Komento-ohjattu käsittely ja validointi*: Mitkä ovat komento-ohjattujen vuorovaikutusten käsittely- ja validointisäännöt, jos tätä tyyliä tarvitaan?
* *Tapahtumapohjaiset vuorovaikutukset*: Mitkä tapahtumat on julkaistava tai hyödynnettävä, jos sellaisia on?
* *Tapahtumapohjaiset syötteet ja vasstaukset*: Mitkä ovat tapahtumapohjaisten vuorovaikutusten syötteet ja vastaukset, jos tätä tyyliä tarvitaan?
* *Tapahtumapohjainen käsittely ja validointi*: Mitkä ovat tapahtumapohjaisten vuorovaikutusten käsittely- ja validointisäännöt, jos tätä tyyliä tarvitaan?
#### REST-kanvas
Miten API voidaan suunnitella REST-periaatteiden mukaisesti?
* *APIn resurssit*: Mitkä ovat keskeiset resurssit, joita API paljastaa?
* *APIn resurssimalli*: Millainen on APIn resurssimallin rakenne?
* *APIn verbit*: Mitä HTTP-verbejä käytetään APIn resurssien kanssa vuorovaikutuksessa?
* *API-verbin esimerkki*: Anna esimerkki API-pyynnöstä ja -vastauksesta kullekin verbille.
#### Tapahtumakanvas
Mitkä tapahtumat ovat olennaisia kyvykkyydelle tai rajapinnalle ja miten ne käsitellään?
* *Käyttäjän tehtävä / Laukaisija*: Mikä käyttäjän toiminto tai järjestelmätapahtuma laukaisee tämän tapahtuman?
* *Syöte / Tapahtumakuorma*: Mitä tietoja saapuva tapahtumakuorma sisältää? Määrittele keskeiset attribuutit.
* *Käsittely / Logiikka*: Kuvaile taustajärjestelmän käsittelylogiikka mukaan lukien validoinnit, muunnokset ja reitityspäätökset.
* *Tulos / Tapahtuman lopputulos*: Mikä tapahtuma tai kuittaus syntyy? Sisällytä vastauksen attribuutit.
#### GraphQL-kanvas
Miten API voidaan suunnitella GraphQL-periaatteiden mukaisesti?
* *APIn nimi*: Mikä on GraphQL-API:n tai päätepisteen nimi?
* *Käyttäjien tavoitteet*: Mitä ongelmia API:n käyttäjät yrittävät ratkaista? Mitä dataa he tarvitsevat?
* *Keskeiset tyypit*: Mitkä ovat keskeiset tyypit (esim. User, Order, Product)?
* *Suhteet*: Miten tyypit liittyvät toisiinsa sisäkkäisissä kyselyissä?
* *Kyselyt*: Mitä yleisiä kyselyitä pitäisi tukea?
* *Mutaatiot*: Mitkä toiminnot muuttavat dataa (esim. luonti, päivitys, poisto)?
* *Tilaukset*: Onko reaaliaikaisia päivityksiä tai tapahtumia, joita voi tilata?
* *Valtuutussäännöt*: Kuka voi käyttää mitäkin kenttiä tai tyyppejä?
* *Käyttäjärajoitukset*: Onko sivutukseen, suodatukseen tai nopeusrajoihin liittyviä rajoitteita?
* *Huomiot / Avoimet kysymykset*: Onko keskeneräisiä päätöksiä tai integraatioon liittyviä huomioita?
h3. Other related resources
* *Integraatiotavan valintaopas*: Ohje API-, tapahtuma-, tiedosto-, tietovirta-, datatuote-, suora integraatio- tai hybriditoteutustavan valintaan vaatimusten ja rajoitteiden perusteella.
* *Sopimuslähtöinen suunnittelu*: Suuntaviiva, jossa kannatetaan API-lähestymistapaa, jossa käytetään virallisia sopimuksia (esim. OpenAPI) sidosryhmien yhdenmukaistamiseksi ennen kehitystä.
h2. 5. Integraation toimitus ja operointi
Rakenna, testaa, automatisoi, julkaise ja operoi integraatiokyvykkyyttä sen valitulla toteutustavalla ja validoidulla rajapintasopimuksella.
h3. Station questions
* Käytä kehityksen parhaita käytäntöjä validoidun rajapintasopimuksen toteuttamiseen vakiintuneilla kehyksillä, kirjastoilla ja tiimin standardeilla.
* Rakenna toteutus validoidun rajapintasopimuksen pohjalta vakiintuneilla kehyksillä, kirjastoilla ja tiimin standardeilla.
* Käytä testausohjeistusta toiminnallisuuden, datan laadun, yhteensopivuuden, tietoturvan, suorituskyvyn, resilienssin ja palautumisodotusten varmistamiseen.
* Käytä CI/CD-ohjeistusta koonnin, testauksen, julkaisun, konfiguraation ja jäljitettävyyden automatisointiin.
* Käytä tietoturvaohjeistusta datan, käyttöoikeuksien, tunnistetietojen ja alustarajojen suojaamiseen.
* Käytä auditoinnin tarkistuslistaa varmistaaksesi, että ratkaisu täyttää toiminnalliset ja ei-toiminnalliset vaatimukset, mukaan lukien tietoturva, suorituskyky ja vaatimustenmukaisuus.
* Sovella toimituksen, testauksen, CI/CD:n, operoinnin ja tietoturvan ohjeistusta valittuun toteutustapaan.
* Uudelleenkäytettävä kyvykkyys tarvitsee luotettavan toimituksen ja operoinnin riippumatta siitä, toteutuuko se APIlla, tapahtumavirtana, tiedostosiirtona, datatuotteena vai suorana integraationa.
h3. Other related resources
* *API-kehityksen parhaat käytännöt*: Toteutusohje, jonka avulla validoitu API-rajapintasopimus muutetaan johdonmukaiseksi ja ylläpidettäväksi API-koodipohjaksi vakiokirjastojen, uudelleenkäytettävien mallien ja yhteensovitettujen kehitystyönkulkujen avulla.
* *API-testauksen parhaat käytännöt*: Ohjeet automatisoidun toiminnallisen, suorituskyky- ja tietoturvatestauksen toteuttamiseksi koko rajapinnan elinkaaren ajan.
* *APIOps CI/CD rajapinnoille*: Käyttöönotto-ohjeet, jotka integroivat APIn elinkaaren tehtävät - suunnittelun, testauksen ja hallinnan - jatkuvaan integrointiin ja toimitusputkiin.
* *API-turvallisuuden parhaat käytännöt*: Joukko toimivia valvontatoimia rajapintojen suojaamiseksi, mukaan lukien todennus, valtuutus, salaus, nopeuden rajoittaminen ja putkitason vaatimustenmukaisuustarkastukset.
* *Kumppanien integrointiohjeet*: Integroinnin tarkistuslistat ja viestintämallit kolmannen osapuolen API-suhteiden teknisten ja oikeudellisten näkökohtien hallintaan.
h2. 6. Integraation valmiuden varmistus
Varmista integraation valmius, hallintamalli, laatu, tietoturva, vaatimustenmukaisuus ja operatiivinen näyttö ennen julkaisua.
h3. Station questions
* Käytä auditoinnin tarkistuslistaa uudelleenkäytettävänä laatutarkistuslistana rajapintasopimuksen, dokumentaation, tietoturvan, suorituskyvyn ja vaatimustenmukaisuuden valmiudelle.
* Käytä tarkistuslistoja, linttereitä ja testausvälineitä johdonmukaisuuden ja standardien noudattamisen varmistamiseen.
* Tee yhteistyötä hallintatiimien ja toimialan asiantuntijoiden kanssa varmistaaksesi, että kyvykkyys on valmis tuotantoon.
* Käytä auditointi- ja vaatimustenmukaisuusresursseja varmistaaksesi, että kyvykkyys on valmis hallittuun julkaisuun ja uudelleenkäyttöön.
* Uudelleenkäytettävät kyvykkyydet luovat operatiivisia, dataan, tietoturvaan, tietosuojaan, vaatimustenmukaisuuteen ja hyödyntäjiin liittyviä riskejä. Valmiustarkastukset vähentävät yllätyksiä ennen julkaisua tai tuotantokäyttöä.
h3. Other related resources
* *API-auditoinnin tarkistuslista*: Elinkaaripohjainen tarkistuslista, jolla varmistetaan APIn valmius suunnittelun, toimituksen, julkaisun ja vaatimustenmukaisuuden osalta määriteltyjen auditointikriteerien ja todisteiden avulla.
* *API-vaatimustenmukaisuuden parhaat käytännöt*: Varmista, että rajapinnat täyttävät oikeudelliset, sääntelyyn liittyvät ja sisäiset vaatimukset dokumentoinnin, valvonnan ja automaattisten validointien avulla.
h2. 7. Integraation julkaisu ja kayttoonoton tuki
Julkaise integraatiokyvykkyys, jotta tiimit voivat loytaa sen, arvioida sen, pyytaa kayttooikeutta, suorittaa kayttoonoton, kayttaa sita uudelleen ja saada tukea.
h3. Station questions
* Julkaise kyvykkyyden tiedot asianmukaisiin katalogeihin, portaaleihin, yhdyskäytäviin tai ympäristöihin, jotta useat hyödyntäjät voivat käyttää sitä uudelleen.
* Dokumentoi, miten hyödyntäjät löytävät kyvykkyyden ja käyttävät sitä, mukaan lukien käyttöönotto- ja rekisteröintiprosessit.
* Varmista, että tietoturvamallit, käyttöoikeuskonfiguraatio ja oikeudelliset ehdot ovat selkeitä ja hyödyntäjien saatavilla.
* Julkaise omistajuus, dokumentaatio, käyttöönotto, tukiyhteystiedot, palveluodotukset, elinkaaren tila ja käyttöoikeuspyyntöjen polut.
* Uudelleenkäytettävät kyvykkyydet tuottavat arvoa vain, kun hyödyntäjät löytävät ne, ymmärtävät rajapintasopimuksen ja palveluodotukset, voivat pyytää käyttöoikeutta ja tietävät, kuka omistaa tuen ja elinkaaripäätökset.
h3. Other related resources
* *API-käyttöönoton parhaat käytännöt*: Parhaat käytännöt API-asiakkaiden käyttöönoton sujuvoittamiseksi vaiheittaisella rekisteröinnillä, tutustumisella ja ensisoitto-opastuksella.
* *Palvelusopimusmalli*: Mukautettava sopimusmuoto, jossa määritellään odotukset, SLA:t, vastuut ja käyttöoikeusehdot API-käyttöä varten.
h2. 8. Integraation seuranta ja parantaminen
Seuraa integraation luotettavuutta, uudelleenkäyttöä, häiriöitä, suorituskykyä, hyödyntäjien tuloksia ja parannustarpeita.
h3. Station questions
* Käytä mittari- ja analytiikkaohjeistusta kyvykkyyden käytön, luotettavuuden, datan laadun, kustannusten, käyttöönoton ja hyödyntäjäarvon mittareiden määrittelyyn.
* Analysoi käyttömittareita ja ota hyödyntäjien palaute mukaan kyvykkyyden kehitysversioihin.
* Luo tapa tarkastella mittareita ja suunnitella jatkuvan parantamisen toimia.
* Käytä mittareita, analytiikkaa ja osallistamisen käytäntöjä kyvykkyyden jatkuvaan parantamiseen.
* Kyvykkyydet tarvitsevat jatkuvaa palautetta pysyäkseen luotettavina, arvokkaina, kustannustehokkaina ja uudelleenkäytettävinä, kun hyödyntäjät, järjestelmät, data ja alustat muuttuvat.
h3. Other related resources
* *API-mittarit ja analytiikka*: Resurssi API-suorituskyvyn ja käyttötietojen määrittelyyn, keräämiseen ja analysointiin, jotta tekniset KPI:t voidaan sovittaa yhteen liiketoiminnan tulosten kanssa.
* *API-yhteisön sitouttamisstrategiat*: Toimintakirja API-käyttöliittymien käyttöönoton edistämiseksi kehittämällä yhteisöjä sisällön, tukikanavien, palautesilmukoiden ja sosiaalisen sitoutumisen strategioiden avulla.