# API-auditointi — API-tuotteistamisen sykli

Canonical page: https://apiopscycles.com/fi/cycles/api-productization-cycle/stations/api-audit

Language: fi

Entity ID: api-audit

Cycle: [API-tuotteistamisen sykli](https://apiopscycles.com/fi/cycles/api-productization-cycle.md)

Read [shared station guidance](https://apiopscycles.com/fi/stations/api-audit.md) first. The sections below supplement or replace the corresponding shared sections for this cycle. Sections not repeated here retain the shared guidance.

## Journey entry criteria

- Valittu arkkitehtuuri, alusta ja toteutustapa on validoitu olennaisten arkkitehtuuri-, tietoturva- ja alustasidosryhmien kanssa. — The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders. (ID: architecture-patterns-validated)
- Valittu rajapinta tarjoaa hyödyntäjille sopivan abstraktion. — The API is intended to shield consumers from backend complexity and inconsistencies. (ID: hide-backend-discrepancies)
- Rajapintasuunnittelu ja tarjottavat kyvykkyydet ovat jäljitettävissä liiketoiminta-arvoon ja hyödyntäjien tarpeisiin. — The API design and exposed capabilities clearly trace back to business value and user needs. (ID: design-reflects-business-value)
- Rajapintasuunnittelu noudattaa sovittuja suunnittelustandardeja ja käytäntöjä. — The API design follows our shared API product and design conventions. (ID: api-consistency)

## Journey exit criteria

- Valittu arkkitehtuuri, alusta ja toteutustapa on validoitu olennaisten arkkitehtuuri-, tietoturva- ja alustasidosryhmien kanssa. — The chosen API architecture and platform patterns have been validated with the relevant architecture, security, and platform stakeholders. (ID: architecture-patterns-validated)
- Rajapintasuunnittelu ja tarjottavat kyvykkyydet ovat jäljitettävissä liiketoiminta-arvoon ja hyödyntäjien tarpeisiin. — The API design and exposed capabilities clearly trace back to business value and user needs. (ID: design-reflects-business-value)
- Rajapinta ja sen kyvykkyydet on dokumentoitu riittävän selkeästi katselmointia, auditointia ja käyttöönottoa varten. — The API and its exposed capabilities are described clearly enough for review, audit, and onboarding. (ID: api-description-available)
- Rajapintasuunnittelu noudattaa sovittuja suunnittelustandardeja ja käytäntöjä. — The API design follows our shared API product and design conventions. (ID: api-consistency)
- Rajapintasopimus on validoitu ja testattu toiminnallisia ja ei-toiminnallisia vaatimuksia vasten. — The API contract is tested and meets functional and non-functional requirements. (ID: api-contract-tested)

## Description

Varmista, että APIt täyttävät liiketoiminta-, suunnittelu- ja toimintastandardit ennen julkaisua ja käyttöönottoa.

## Why it matters

APIt ovat pitkäikäisiä tuotteita, ja niiden on täytettävä laatu-, johdonmukaisuus- ja vaatimustenmukaisuusodotukset. Auditointi yhdistää suunnittelupäätökset, toteutuksen ja toimintavalmiuden määriteltyihin standardeihin, mikä vähentää riskejä ennen käyttöönottoa.

## Apply in work

Luo johdonmukainen auditointiprosessi, joka arvioi APIn valmiutta elinkaaren eri vaiheissa määriteltyjen kriteerien, todisteiden ja standardien avulla. Varmista, että puutteet tunnistetaan varhaisessa vaiheessa ja korjataan ennen julkaisua.

## Outcomes

- APIt täyttävät sisäiset ja ulkoiset standardit
- Selkeä dokumentaatio API-suunnittelusta ja toteutuspäätöksistä
- Turvallisuus, suorituskyky ja vaatimustenmukaisuus validoitu
- Tuotannossa ilmenevien ongelmien riskin pienentäminen

## Steps

1. Suorita tarkastuksia varmistaaksesi, että rajapinnat täyttävät organisatoriset, tekniset ja oikeudelliset standardit ennen julkaisemista.
2. Käytä tarkistuslistoja, automatisoituja tarkistustyökaluja eli linttereitä ja testausvälineitä varmistaaksesi johdonmukaisuuden ja standardien noudattamisen.
3. Tee yhteistyötä hallintotiimien ja toimialan asiantuntijoiden kanssa varmistaaksesi, että rajapinnat ovat valmiita tuotantoon.
4. Päätä, onko julkaisu valmis, ehdollisesti valmis, vaatiiko se korjauksia vai eikö sitä hyväksytä.
5. Kirjaa päätöksen omistaja, päätöspäivä ja käytetty näyttö.
6. Varmista, ettei mitään julkaista ilman selkeää liiketoiminnan ja operoinnin omistajuutta.

## Questions

- Suorita tarkastuksia varmistaaksesi, että rajapinnat täyttävät organisatoriset, tekniset ja oikeudelliset standardit ennen julkaisemista.
- Käytä tarkistuslistoja, automatisoituja tarkistustyökaluja eli linttereitä ja testausvälineitä varmistaaksesi johdonmukaisuuden ja standardien noudattamisen.
- Tee yhteistyötä hallintotiimien ja toimialan asiantuntijoiden kanssa varmistaaksesi, että rajapinnat ovat valmiita tuotantoon.
- Luo johdonmukainen auditointiprosessi, joka arvioi APIn valmiutta elinkaaren eri vaiheissa määriteltyjen kriteerien, todisteiden ja standardien avulla. Varmista, että puutteet tunnistetaan varhaisessa vaiheessa ja korjataan ennen julkaisua.
- APIt ovat pitkäikäisiä tuotteita, ja niiden on täytettävä laatu-, johdonmukaisuus- ja vaatimustenmukaisuusodotukset. Auditointi yhdistää suunnittelupäätökset, toteutuksen ja toimintavalmiuden määriteltyihin standardeihin, mikä vähentää riskejä ennen käyttöönottoa.

## Role participation and responsibilities

- [API-hallinnan omistaja](https://apiopscycles.com/fi/roles/governance-specialist.md) (lead): Vastaa API-hallintaprosesseista, ohjeista ja päätöksenteosta, joka määrittelee, miten API-kehityspäätökset tehdään ja dokumentoidaan.
- [API-suunnittelija](https://apiopscycles.com/fi/roles/api-designer.md) (core): Suunnittelee rajapintasopimuksen, vuorovaikutusmallin, johdonmukaisuuden, käytettävyyden ja tarjottavat kyvykkyydet.
- [Toimituskehittäjä](https://apiopscycles.com/fi/roles/api-engineer.md) (core): Vastaa toteutuksesta, automaatiosta, testauksesta ja julkaisun kulusta, joita kyvykkyyden, APIn tai automaation luotettava toimittaminen edellyttää.
- [Turvallisuusasiantuntija](https://apiopscycles.com/fi/roles/security-specialist.md) (core): Varmistaa, että turvallisuusriskit, kontrollit ja luottamusrajat käsitellään koko elinkaaren aikana.
- [Vaatimustenmukaisuus- ja lakiasiantuntija](https://apiopscycles.com/fi/roles/compliance-specialist.md) (core): Selventää juridiset, tietosuojaan liittyvät, sääntelyyn liittyvät ja sopimukselliset vaatimukset, jotka vaikuttavat kyvykkyyteen, APIin, rajapintaan tai automaatioon.
- [Alusta-arkkitehti](https://apiopscycles.com/fi/roles/platform-architect.md) (consulted): Ohjaa alustan, integraation, skaalautuvuuden ja arkkitehtuurin päätöksiä, jotka määrittelevät, miten kyvykkyys tai API rakennetaan ja operoidaan.
- [API-tuoteomistaja](https://apiopscycles.com/fi/roles/api-product-owner.md) (consulted): Ohjaa API-mahdollisuutta, priorisointia ja tuotetasolla tehtyjä päätöksiä elinkaaren aikana.
- [Liiketoiminnan omistaja](https://apiopscycles.com/fi/roles/business-owner.md) (consulted): Edustaa liiketoimintatavoitteita, rahoitusta ja odotettuja tuloksia kyvykkyys-, API- tai automaatiohankkeessa.
- [Tuki- ja operaatioiden omistaja](https://apiopscycles.com/fi/roles/operations-specialist.md) (consulted): Edustaa tuotannon tukea, häiriönhallintaa, havainnoitavuutta ja operatiivista valmiutta kyvykkyydelle, APIlle tai automaatiolle.

## Resources

- [API-auditoinnin tarkistuslista](https://apiopscycles.com/fi/resources/api-audit-checklist.md)