APIpäringut

API päring on kliendi ja serveri vahel esitatud taotlus, mille eesmärk on saada andmeid või teostada toiminguid vastavalt API kirjeldustele. Päringus määratakse, millist ressursi soovitakse ja milliseid andmeid või operatsioone see Eeldab.

Päringusse kuuluvad mitmed koostisosad: lõpp-punkt ehk endpoint URL, HTTP meetod (näiteks GET, POST, PUT, DELETE), päringuväärtused ehk query parameters ning päised ehk headers. Kui meetod nõuab keha, lisatakse see tavaliselt JSON- või vormikoodinguga (body). Mõnel juhul kasutatakse ka URL-i tasemel kodeeritud parameetreid või küpsiseid.

Paljud API-d nõuavad autentimist turvalisuse tagamiseks. Päringusse lisatakse sobivad autentimis- või autoriseerimissandmed, näiteks API võti, OAuth-token või muu skeem. Turvaliseks ühenduseks kasutatakse sageli HTTPS-i. Päringu autoriseerimine peab järgima teenuse dokumentatsiooni.

Vastus sisaldab staatusekoodi ja vastuse keha, sageli JSON- või XML-versioonina. Üksikasjad varieeruvad sõltuvalt API-st, kuid levinud staatuskoodid hõlmavad 200 OK, 201 Created, 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 429 Too Many Requests ja 5xx vead. Vastus võib sisaldada andmeid, veainformatsiooni või tehingu tulemusi.

REST ja GraphQL on levinud API arhitektuurimudelid. REST jagab ressursse URL-ide kaudu ning kasutab erinevaid meetodeid, GraphQL võimaldab ühe endpointi kaudu täpsustada, milliseid andmeid soovitakse. Päringute haldamisel on oluline järgida parimaid tavasid, sealhulgas minimaalsete andmete kasutamine, päringute järjepidev dokumenteerimine, päringute lehe- või sivimise (pagination) kasutamine ja tõhus logimine.