API-julkaiseminen

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

Tulokset

• APIt julkaistaan oikeassa ympäristössä (yksityinen, kumppani, julkinen).

Liittyvät metrolinjat

• Julkaisu- ja hyväksymislinja

Miksi sillä on merkitystä

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.

Pääsykriteerit

• API läpäisee vaatimustenmukaisuus-, turvallisuus- ja auditointitarkastukset.
• Auditointiraportit jaetaan sidosryhmille.
• API on valmis julkaistavaksi sopiville yhdyskäytäville ja ympäristöihin, jotta se tukee uudelleenkäytettävyyttä useille API-käyttäjille.
• API-dokumentaatio on valmis ja julkaisuvalmis.

Poistumiskriteerit

• API-dokumentaatio on valmis ja julkaisuvalmis.
• API-rekisteröinti-, tuki- ja viestintäprosessit ovat käytössä.
• Lakisääteiset ja vaatimustenmukaisuusvaatimukset ovat riittävän tarkat julkaisemista varten.

Näin se toimii

1. Julkaise rajapinnat asianmukaisiin yhdyskäytäviin ja ympäristöihin, jotta ne ovat uudelleenkäytettävissä useille rajapinnan käyttäjille.
2. Dokumentoi, miten hyödyntäjät löytävät ja käyttävät sovellusliittymää, mukaan lukien sisäänkirjautumisprosessit ja rekisteröinti.
   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. Varmistetaan, että turvamallit, yhdyskäytävän kokoonpano ja oikeudelliset ehdot ovat selkeitä ja kuluttajien saatavilla.
   API-auditoinnin tarkistuslista Kattava tarkistuslista API-valmiuden tarkistamiseksi ennen julkaisemista, joka kattaa suunnittelun, dokumentoinnin, tietoturvan ja käytäntöjen noudattamisen.

Sovella työssäsi

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.