Station

API-julkaisu

Esittele APIt turvallisesti ja selkeästi oikealle yleisölle oikean dokumentaation ja prosessien avulla.

Julkaiseminen on muutakin kuin käyttöönottoa - kyse on löydettävyydestä, saatavuudesta ja tuesta. Jos rajapintoja ei julkaista oikein, niitä ei käytetä, käytetä uudelleen tai suojata tehokkaasti.

Reittisi kartalla

Metrokartta

Select a cycle, station, or stakeholder to open its permanent method page.

StrateginenHallintaKäyttäjäTekninenKäyttäjäkokemusKäyttäjäkokemusMarkkinatietoaMarkkinatietoaLiiketoiminnalliset tavoitteetLiiketoiminnalliset tavoitteetKilpailuanalyysiKilpailuanalyysiEkosysteemin visioEkosysteemin visioSkaalautuva infrastruktuuriSkaalautuva infrastruktuuriLainsäädäntö ja vaatimustenmukaisuusLainsäädäntö ja vaatimustenmukaisuusTietoturva ja yksityisyysTietoturva ja yksityisyysSuunnittelustandarditSuunnittelustandarditToimittajan hallintaToimittajan hallintaSopimussuunnitteluSopimussuunnitteluKehitysKehitysCI/CDCI/CDTestausautomaatioTestausautomaatioJulkaisunhallintaJulkaisunhallintaPalvelusopimuksetPalvelusopimuksetAPIn käyttöönottoAPIn käyttöönottoAPI-näkyvyysAPI-näkyvyysKumppanien integrointiKumppanien integrointiAPI-ajattelutapaAPI-ajattelutapaRoolit ja vastuualueetRoolit ja vastuualueetOsaamisen kehittäminenOsaamisen kehittäminenToimintaohjeetToimintaohjeetPortfolionhallintaPortfolionhallintaBudjetin ja resurssien hallintaBudjetin ja resurssien hallintaStrategia1API-tuotestrategiaHyödyntäjien vaatimukset ja käyttöönotto2API-hyödyntäjäkokemusArkkitehtuuri- ja alustapäätökset3API-alustanarkkitehtuuriRatkaisu- ja rajapintasuunnittelu4API-suunnitteluToimitus ja operointi5API-toteutusLaadun ja valmiuden varmistus6API-auditointiJulkaisu ja käyttöönoton mahdollistaminen7API-julkaisuSeuranta ja parantaminen8APIen seuranta japarantaminenLiiketoimintamahdollisuuksien linjaAlusta-arkkitehtuurilinjaAPI-suunnittelulinjaToimituslinjaJulkaisu- ja käyttöönoton linjaToimintamallilinja

Selected station: Julkaisu ja käyttöönoton mahdollistaminen

Tarvittavat sidosryhmät

Liittyvät resurssit

Tulokset

  • APIt julkaistaan oikeassa ympäristössä (yksityinen, kumppani, julkinen).
  • Selkeät API-käyttöönotto- ja rekisteröintiprosessit
  • Dokumentaatio, turvallisuusmallit ja -käytännöt saatavilla
  • APIt valmiina skaalautumiseen ja hallintaan

Matkan kriteerit

Aloituskriteerit

  • Valittu arkkitehtuuri, alusta ja toteutustapa on validoitu olennaisten arkkitehtuuri-, tietoturva- ja alustasidosryhmien kanssa.
  • Rajapintasuunnittelu ja tarjottavat kyvykkyydet ovat jäljitettävissä liiketoiminta-arvoon ja hyödyntäjien tarpeisiin.
  • Rajapinta ja sen kyvykkyydet on dokumentoitu riittävän selkeästi katselmointia, auditointia ja käyttöönottoa varten.
  • Rajapintasuunnittelu noudattaa sovittuja suunnittelustandardeja ja käytäntöjä.
  • Rajapintasopimus on validoitu ja testattu toiminnallisia ja ei-toiminnallisia vaatimuksia vasten.

Valmistumiskriteerit

  • Ratkaisu läpäisee laatu-, tietoturva-, vaatimustenmukaisuus- ja valmiustarkastukset.
  • Auditointihavainnot ja korjauspäätökset on jaettu olennaisille sidosryhmille.
  • Kyvykkyys on valmis julkaistavaksi tai toimitettavaksi valitun toimitusmekanismin kautta.
  • Hyödyntäjille suunnattu dokumentaatio ja käyttöönottomateriaalit ovat valmiit.

Tältä onnistuminen näyttää

Mahdollistetaan APIen julkaiseminen asiaankuuluvassa ympäristössä ja selkeät rekisteröinti- ja käyttöoikeusmekanismit (esim. API-avaimet, OAuth, tilaussuunnitelmat) API-hyödyntäjäsegmenttien sekä turvallisuus- ja vaatimustenmukaisuusvaatimusten mukaan.

  1. Julkaise rajapinnat asianmukaisiin yhdyskäytäviin ja ympäristöihin, jotta ne ovat uudelleenkäytettävissä useille API-hyödyntäjille.
  2. Dokumentoi, miten hyödyntäjät löytävät ja käyttävät rajapintaa, mukaan lukien sisäänkirjautumisprosessit ja rekisteröinti.
  3. Varmista, että turvamallit, yhdyskäytävän kokoonpano ja oikeudelliset ehdot ovat selkeitä ja hyödyntäjien saatavilla. — API-auditoinnin tarkistuslista

Metro lines

Liittyvät resurssit

Browse the resources selected for API-julkaisu; the summary above explains how they support this station’s work.

Resurssit

Resources for API-julkaisu

checklist

API-auditoinnin tarkistuslista

Elinkaaripohjainen tarkistuslista, jolla varmistetaan APIn valmius suunnittelun, toimituksen, julkaisun ja vaatimustenmukaisuuden osalta määriteltyjen auditointikriteerien ja todisteiden avulla.

Tulokset

  • Yhteinen ymmärrys resurssin API-auditoinnin tarkistuslista tarkoituksesta ja käytöstä
  • Johdonmukainen tapa soveltaa resurssia API-auditoinnin tarkistuslista
  • Asiaan liittyvien käytäntöjen parempi soveltaminen

Näin se toimii

  1. Varmista API-auditoinnin tarkistuslistan avulla, että API-design täyttää toiminnalliset ja muut kuin toiminnalliset vaatimukset, mukaan lukien tietoturva, suorituskyky ja vaatimustenmukaisuus.
  2. Suorita auditointeja elinkaaren kattavuuden arvioimiseksi ja varmista, että API täyttää liiketoiminta-, suunnittelu- ja toimintastandardit.
  3. Varmista, että dokumentaatio, tietoturvamallit, gateway-konfiguraatio ja lakisääteiset vaatimukset on määritelty selkeästi, validoitu ja tuettu todisteilla.

Relevant cycles

Kyvykkyyden tuotteistamisen sykli

Sykli liiketoiminnan kyvykkyyksien muuttamiseen uudelleenkäytettäviksi digitaalisiksi kyvykkyyksiksi ennen toteutustavan valintaa.

API-tuotteistamisen sykli

API-keskeinen APIOps Cycles -polku APIen tuotteistamiseen, suunnitteluun, toimittamiseen, julkaisuun ja parantamiseen.

Automaatiosykli

Sykli automaatiomahdollisuuksien tunnistamiseen, suunnitteluun, toimittamiseen, käyttöönoton mahdollistamiseen ja parantamiseen.