APIviestit

APIviestit ovat tiedon yksiköitä, joita asiakkaat ja palvelimet vaihtavat sovellusrajapinnan (API) kautta. Ne esiintyvät sekä pyynnön että vastauksen viesteinä ja niihin sisältyy sekä viestin runko (tiedot) että metatietoja, kuten otsikot.

Yleisimmät muodot ovat JSON ja XML, ja siirtotie on tavallisesti HTTP tai HTTPS, vaikka joissakin tapauksissa käytetään myös gRPC:tä tai viestijonoja. Viestin runko sisältää varsinaiset tiedot, otsikot ohjaavat ja kuvaavat viestin ominaisuuksia, kuten sisällön tyyppi ja valtuutus.

REST-tyyppisissä API-viesteissä pyyntömetodi (GET, POST, PUT, DELETE) määrittää halutun toimenpiteen, ja vastauksessa näkyy tilakoodi, joka kertoo tuloksen. Monissa ympäristöissä käytetään koneellisesti luettavia skeemoja (esimerkiksi OpenAPI tai Protobuf) viestien rakenteen määrittämiseen ja validointiin.

Synkroninen viestintä tarkoittaa pyyntö-vastausmallia, kun taas asynkroninen viestintä voi toteutua webhook-viesteinä, julkaisija-tilaaja -malleina tai tapahtumavirtoina. Suuret tietomäärät, sivutus ja virhetilanteisiin palautuminen ovat tyypillisiä suunnittelukysymyksiä.

Turvallisuus ja versionhallinta ovat keskeisiä. Autentikointi API-avaimilla tai OAuthilla, TLS-salaus, sekä joskus viestien allekirjoitus parantavat turvallisuutta. Versionointi säilyttää sovellusten yhteensopivuuden API:n kehittyessä, ja deprekaatio-politiikat ohjaavat muutoksia.