Co znamená API?

Zkratka API pro Application Programming Interface znamená sadu funkčních kódů, které aplikacím umožňují přístup ke specifikovaným datům a interakci s externími komponentami softwarových aplikací, operačními systémy nebo mikroslužbami.

Pro zjednodušení API doručuje uživatelskou odpověď do systému a odešle odpověď systému zpět uživateli. Kliknete na „přidat do košíku“; API říká webu, že jste přidali produkt do košíku; webová stránka vloží produkt do vašeho košíku a váš košík se aktualizuje.

V souvislosti s API můžete slyšet termín „mikroslužby“. Tyto však nejsou stejné. Mikroslužby jsou styl nebo architektura, která rozděluje funkčnost v rámci webové aplikace. Zatímco API je rámec, který vývojáři komunikují s webovou aplikací. Mikroslužby skutečně mohou používat API ke komunikaci mezi sebou.

Rozhraní API umožňuje vývojáři provést konkrétní „volání“ nebo „požadavek“ za účelem odeslání nebo přijetí informací. Tato komunikace se provádí pomocí programovacího jazyka zvaného „JSON“. Lze jej také použít k provedení definované akce, jako je aktualizace nebo mazání dat. Existují čtyři základní metody požadavků, které lze provést pomocí API:

GET – shromažďuje informace (stahování všech kódů kupónů)

PUT – Aktualizuje části dat (Aktualizace cen produktu)

POST – vytvoří (vytvoření nové kategorie produktu)

DELETE – (Smazání příspěvku na blogu)

Co je JSON a proč se používá?

JSON (JavaScript Object Notation) se používá k reprezentaci dat na serveru. Je poměrně snadno čitelný pro lidi a snadno pochopitelný pro stroje/aplikace. Podívejme se na příklad JSON z produktu na BigCommerce:

To je snadno pochopitelné, protože se zobrazuje v párech klíč/hodnota, s klíčem vlevo a hodnotou vpravo. Klíče jsou pevným objektem definovaným aplikací a zůstanou stejné jako u „kategorie“. Zatímco hodnoty budou jedinečné, například „Košile“.

Co je žádost API?

Aby požadavek API fungoval, existuje několik komponent. Pojďme si je probrat jednotlivě a jak je lze použít k vytvoření požadavku.

Co je Endpoint?

Existují dvě klíčové části koncového bodu, které se používají při vytváření požadavku API. Jedním z nich je URL. BigCommerce používá https://api.bigcommerce.com/stores/ jako adresu URL pro všechny požadavky API. Může to vypadat jako běžná adresa URL, ale pokud ji připojíte do webového prohlížeče, zobrazí se chybová zpráva 404.

Druhá část je cesta. Cesta se bude lišit v závislosti na tom, čeho se snažíte dosáhnout. Seznam dostupných cest pro BigCommerce naleznete v naší dokumentaci pro vývojáře: https://developer.bigcommerce.com/api-reference. Pro tento příklad použijeme cestu k produktu, která je /v3/catalog/products.

Když dáme tyto dvě části dohromady, dostaneme kompletní koncový bod https://api.bigcommerce.com/stores/{store_hash}/v3/catalog/products. Možná si teď říkáte: „Co je to {store_hash}?“ „Odkud se to vzalo?“ To je to, co je známé jako proměnná. Proměnné jsou jedinečné součásti koncového bodu a budou se lišit v závislosti na informacích o vašem obchodě. Proměnnou poznáte podle otevřených a uzavřených závorek „{}“.

Co je záhlaví?

Záhlaví poskytují informace klientovi a serveru. Běžnými příklady záhlaví mohou být ověřovací údaje, jako je „Auth Token“ nebo „Client ID“. Tyto přihlašovací údaje jsou vám poskytnuty automaticky, když si vytvoříte účet API. Další běžná hlavička je označována jako „Content Type“, která informuje server o tom, jaký typ obsahu bude odeslán. Například běžně používaný typ obsahu je „application/json“, který dává serveru vědět, že posíláme data JSON.

Co je metoda?

Metody jsou akce provedené při odesílání požadavku. Vzpomeňte si na začátek, kdy jsme diskutovali o GET, PUT, POST a DELETE. To vše jsou metody API.

Co je to Data?

Data požadavku, běžně označovaná také jako „tělo“, jsou informace, které budou odeslány nebo vráceny serverem. V předchozí diskusi o JSON můžete vidět příklad dat API. Tělo žádosti bude někdy vyžadovat konkrétní informace, než bude možné ji doručit. Příkladem je, že pokud upravujete jeden produkt, bude před provedením jakékoli změny vyžadováno ID produktu.

Dozvědět se více zde.