Kaj pomeni API?

Okrajšava API za Application Programming Interface pomeni nabor funkcijskih kod, ki aplikacijam omogočajo dostop do določenih podatkov in interakcijo z zunanjimi komponentami aplikacij programske opreme, operacijskimi sistemi ali mikrostoritvami.

Če poenostavimo, API dostavi odziv uporabnika sistemu in pošlje odgovor sistema nazaj uporabniku. Kliknite »dodaj v košarico«; API sporoči spletnemu mestu, da ste izdelek dodali v košarico; spletno mesto da izdelek v vaš voziček in vaš voziček se posodobi.

Morda boste slišali izraz "mikrostoritve" v zvezi z API-jem. Vendar ti niso enaki. Mikrostoritve so slog ali arhitektura, ki deli funkcionalnost znotraj spletne aplikacije. Medtem ko je API ogrodje, s katerim razvijalci komunicirajo s spletno aplikacijo. Mikrostoritve dejansko lahko uporabite API za komunikacijo med seboj.

API razvijalcu omogoča poseben »klic« ali »zahtevo« za pošiljanje ali prejemanje informacij. Ta komunikacija poteka z uporabo programskega jezika, imenovanega »JSON«. Uporablja se lahko tudi za izvedbo določenega dejanja, kot je posodabljanje ali brisanje podatkov. Obstajajo štiri osnovne metode zahtev, ki jih je mogoče narediti z API-jem:

GET – zbira informacije (povleče vse kode kuponov)

PUT – Posodablja podatke (posodabljanje cen izdelkov)

POST – Ustvari (ustvarjanje nove kategorije izdelkov)

DELETE – (Brisanje objave v blogu)

Kaj je JSON in zakaj se uporablja?

JSON (JavaScript Object Notation) se uporablja za predstavitev podatkov na strežniku. Ljudje ga dokaj enostavno berejo, stroji/aplikacije pa ga zlahka razumejo. Oglejmo si primer JSON iz izdelka na BigCommerce:

To je enostavno razumeti, saj je izpisano v parih ključ/vrednost, s ključem na levi in ​​vrednostjo na desni. Ključi so fiksni objekt, ki ga določi aplikacija in bodo ostali enaki kot pri »kategoriji«. Medtem ko bodo vrednosti edinstvene, na primer »Srajce«.

Kaj je zahteva API?

Za delovanje zahteve API obstaja več komponent. Oglejmo jih posamično in kako jih je mogoče uporabiti za izdelavo zahteve.

Kaj je končna točka?

Obstajata dva ključna dela končne točke, ki se uporabljata pri izdelavi zahteve API. Eden od njih je URL. BigCommerce uporablja https://api.bigcommerce.com/stores/ kot URL za vse zahteve API-ja. To je morda videti kot običajni URL, vendar če ga priključite v spletni brskalnik, boste prejeli sporočilo o napaki 404.

Drugi del je pot. Pot se bo razlikovala glede na to, kaj poskušate doseči. Seznam razpoložljivih poti za BigCommerce najdete v naši dokumentaciji za razvijalce: https://developer.bigcommerce.com/api-reference. Za ta primer bomo uporabili pot izdelka, ki je /v3/catalog/products.

Ko ta dva dela združimo, dobimo celotno končno točko https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products. Zdaj se morda sprašujete »Kaj je {store_hash}?« »Od kod je to prišlo?« To je tisto, kar je znano kot spremenljivka. Spremenljivke so edinstvene komponente končne točke in se razlikujejo glede na podatke vaše trgovine. Spremenljivko lahko opazite po odprtih in zaprtih oklepajih »{}«.

Kaj je glava?

Glave zagotavljajo informacije odjemalcu in strežniku. Pogosti primeri glave so poverilnice za preverjanje pristnosti, kot sta »Auth Token« ali »Client ID«. Te poverilnice so samodejno posredovane, ko ustvarite račun API. Druga pogosta glava se imenuje »Vrsta vsebine«, ki obvešča strežnik o tem, kakšna vrsta vsebine bo poslana. Na primer, pogosto uporabljena vrsta vsebine je »application/json«, ki strežniku sporoči, da pošiljamo podatke JSON.

Kaj je metoda?

Metode so dejanja, izvedena ob pošiljanju zahteve. Pomislite na začetek, ko smo razpravljali o GET, PUT, POST in DELETE. Vse to so metode API.

Kaj so podatki?

Podatki zahteve, običajno imenovani tudi »telo«, so informacije, ki bodo poslane strežniku ali pa jih bo vrnil. V prejšnji razpravi o JSON si lahko ogledate primer podatkov API. Telo zahteve bo včasih zahtevalo posebne informacije, preden bo lahko dostavljeno. Primer tega je, če urejate en sam izdelek, bo zahtevan ID izdelka, preden bo mogoče narediti kakršno koli spremembo.

Preberi več tukaj.