Čo znamená API?

Skratka API pre Application Programming Interface znamená súbor funkčných kódov umožňujúcich aplikáciám prístup k špecifikovaným údajom a interakciu s externými komponentmi softvérových aplikácií, operačnými systémami alebo mikroslužbami.

Pre zjednodušenie, API doručí odpoveď užívateľa do systému a odošle odpoveď systému späť užívateľovi. Kliknete na „pridať do košíka“; API informuje stránku, že ste pridali produkt do košíka; webová stránka vloží produkt do vášho košíka a váš košík sa aktualizuje.

V súvislosti s API môžete počuť výraz „mikroslužby“. Tieto však nie sú rovnaké. Mikroslužby sú štýl alebo architektúra, ktorá rozdeľuje funkčnosť v rámci webovej aplikácie. Zatiaľ čo API je rámec, ktorý vývojári interagujú s webovou aplikáciou. Mikroslužby skutočne môžu používať API na komunikáciu medzi sebou.

Rozhranie API umožňuje vývojárovi uskutočniť konkrétny „hovor“ alebo „požiadavku“, aby mohol odoslať alebo prijať informácie. Táto komunikácia prebieha pomocou programovacieho jazyka s názvom „JSON“. Môže sa tiež použiť na vykonanie definovanej akcie, ako je aktualizácia alebo vymazanie údajov. Existujú štyri základné metódy požiadaviek, ktoré možno vykonať pomocou API:

GET – Zhromažďuje informácie (vytiahnutie všetkých kódov kupónov)

PUT – Aktualizuje časti údajov (Aktualizácia cien produktov)

POST – vytvorí (vytvorenie novej kategórie produktov)

DELETE – (odstránenie blogového príspevku)

Čo je JSON a prečo sa používa?

JSON (JavaScript Object Notation) sa používa na reprezentáciu údajov na serveri. Je pomerne ľahko čitateľný pre ľudí a ľahko pochopiteľný pre stroje/aplikácie. Pozrime sa na príklad JSON z produktu na BigCommerce:

Je to ľahko pochopiteľné, pretože sa zobrazuje v pároch kľúč/hodnota, pričom kľúč je vľavo a hodnota vpravo. Kľúče sú pevným objektom definovaným aplikáciou a zostanú rovnaké ako v prípade „kategórie“. Zatiaľ čo hodnoty budú jedinečné, ako napríklad „Košele“.

Čo je to žiadosť o rozhranie API?

Požiadavka API obsahuje niekoľko komponentov, aby mohla fungovať. Pozrime sa na to jednotlivo a na to, ako ich možno použiť na vytvorenie požiadavky.

Čo je Endpoint?

Existujú dve kľúčové časti koncového bodu, ktoré sa používajú pri vytváraní požiadavky API. Jednou z nich je adresa URL. BigCommerce používa https://api.bigcommerce.com/stores/ ako adresu URL pre všetky požiadavky API. Môže to vyzerať ako bežná adresa URL, ale ak ju pripojíte do webového prehliadača, zobrazí sa chybové hlásenie 404.

Druhá časť je cesta. Cesta sa bude líšiť v závislosti od toho, čo sa snažíte dosiahnuť. Zoznam dostupných ciest pre BigCommerce nájdete v našej dokumentácii pre vývojárov: https://developer.bigcommerce.com/api-reference. V tomto príklade použijeme cestu produktu, ktorá je /v3/catalog/products.

Keď spojíme tieto dve časti, dostaneme úplný koncový bod https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products. Teraz si možno hovoríte: „Čo je to {store_hash}?“ „Odkiaľ to prišlo?“ Toto je to, čo je známe ako premenná. Premenné sú jedinečné komponenty koncového bodu a budú sa líšiť v závislosti od informácií o vašom obchode. Premennú zistíte podľa otvorených a uzavretých zátvoriek „{ }“.

Čo je hlavička?

Hlavičky poskytujú informácie klientovi a serveru. Bežnými príkladmi hlavičky by boli overovacie poverenia, ako napríklad „Auth Token“ alebo „ID klienta“. Tieto poverenia sú vám poskytnuté automaticky, keď si vytvoríte účet API. Ďalšia bežná hlavička sa označuje ako „Typ obsahu“, ktorá informuje server o tom, aký typ obsahu bude odoslaný. Napríklad bežne používaný typ obsahu je „application/json“, ktorý dáva serveru vedieť, že posielame údaje JSON.

Čo je metóda?

Metódy sú akcie vykonávané pri odosielaní žiadosti. Spomeňte si na začiatok, keď sme diskutovali o GET, PUT, POST a DELETE. Toto sú všetky metódy API.

Čo sú dáta?

Údaje o požiadavke, bežne označované aj ako „telo“, sú informácie, ktoré budú odoslané alebo vrátené serverom. V predchádzajúcej diskusii o JSON môžete vidieť príklad údajov API. Telo žiadosti si niekedy pred doručením vyžaduje špecifické informácie. Príkladom toho je, že ak upravujete jeden produkt, pred vykonaním akejkoľvek zmeny sa bude vyžadovať ID produktu.

Čítaj viac tu.