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 koskee pyyntö, esimerkiksi /users tai /orders. Otsakkeet määrittävät pyynnön kontekstin; tärkeimmät ovat Authorization, Content-Type ja Accept. Runkona voi olla tieto, erityisesti POST- tai PUT-pyynnöissä, ja sen muoto on tavallisesti JSON tai XML.

Varmennus ja turvallisuus: APIpyynnöt voivat vaatia tunnistamisen, esimerkiksi API-avain, OAuth 2.0 tai JWT. Pyyntöjä saatetaan rajoittaa rate limitingillä, IP-sivustokohtaisilla rajoituksilla sekä salauksella (TLS/HTTPS).

Vastauksena APIpyyntö palauttaa tilinumerot, otsakkeet ja rungon, joka sisältää halutun tiedon tai kommentin toiminnasta. Tilakoodit kertovat pyynnön lopputuloksen: 200 OK, 201 Created, 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 429 Too Many Requests sekä 5xx-virhekoodit. Virheistä annetaan usein virheilmoitus, jonka avulla sovellus voi korjata syötteitä.

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.