APIpyyntö
APIpyyntö on asiakkaan tekemä pyyntö ohjelmointirajapintaan (API) saadakseen dataa tai suorittaakseen toimenpiteen. Tyypillisesti pyyntö sisältää: menetelmän, osoitteen (endpoint), mahdollisia kyselyparametreja sekä otsakkeita ja mahdollisesti rungon.
Siirtomalli on yleensä HTTP. Yleisimmät menetelmät ovat GET, POST, PUT ja DELETE. Endpoint määrittelee resurssin, jota
Varmennus ja turvallisuus: APIpyynnöt voivat vaatia tunnistamisen, esimerkiksi API-avain, OAuth 2.0 tai JWT. Pyyntöjä saatetaan rajoittaa
Vastauksena APIpyyntö palauttaa tilinumerot, otsakkeet ja rungon, joka sisältää halutun tiedon tai kommentin toiminnasta. Tilakoodit kertovat
Yleisiä huomioita: parhaita käytäntöjä ovat pyyntöjen versionointi, selkeät virheilmoitukset, dokumentointi ja testaus ympäristöissä.
Esimerkki: GET https://api.esimerkki.com/users?id=123 with header Authorization: Bearer {token} ja Accept: application/json. Paluu: JSON-objekti, jossa on käyttäjätiedot.