programmeerimisliides

Programmeerimisliides ehk API (Application Programming Interface) on tarkvarakomponentide vahelise koostöö vahend, mis spetsifitseerib, kuidas üks tarkvarakomponent saab kutsuda teist ning milliseid andmeid vastu võtta või anda. API kirjeldab funktsioonide, protseduuride või teenuste kasutamise viisi, sealhulgas andmete vormi ja vea- ning autentimisreegleid.

API’d võib liigitada sõltuvalt kasutusviisist lokaalseteks või kaugelt kättesaadavateks. Veebipõhised API’d kasutavad enamasti HTTP/HTTPS protokolli ning järgivad REST, GraphQL või gRPC arhitektuuri, ja tagastavad andmeid tavaliselt JSONi või XMLi vormis. SOAP on vanem protokoll.

Kõige sagedasemad autentimisviisid on API võti, OAuth 2.0 ja JWT. Hea API on stabiilne ja hästi dokumenteeritud, pakkudes selget kontrakti, versioonimist ja hooldussülke. Versioonimine võimaldab uuendusi ilma katkestusteta; deprecatsioonidega teavitatakse kasutajaid ette.

Olulised disainiprintsiibid on järjepidevus, õige semantika, vähendatud kõrvalekaldeid ja idempotentsus mõnede operatsioonide puhul. Dokumentatsioon, peamised näited ja SDKd (või kliendiraamatukogud) aitavad arendajatel integratsiooni kiiremini lõpetada. Turvalisus on keskne: autentimine, autoriseerimine, andmete krüpteerimine ning hoolikas vigade käsitlemine.

API-de ökossüsteemid võimaldavad erinevate süsteemide integreerimist, automatiseerimist ja arenduste koostööd, luues standardiseeritud liidese paljude teenuste vahel.