Co je API? Průvodce pro tvůrce aplikací bez programování

API (application programming interface) je definovaný způsob, jak jeden software žádá jiný o data nebo jak ho přimět, aby něco udělal. Vaše aplikace pošle požadavek v dohodnutém formátu — „dej mi zítřejší rezervace“, „strhni z této karty 20 €“, „shrň tento text“ — a druhý systém vrátí strukturovanou odpověď. API jsou způsob, jak spolu části aplikace komunikují, a jak vaše aplikace používá externí služby jako platby, e-mail, mapy nebo AI.

Proč jsou API důležitá při tvorbě s AI

Téměř každá užitečná aplikace se skládá z částí, které spolu komunikují přes API:

• Uvnitř vaší aplikace obrazovky v prohlížeči volají API vašeho vlastního backendu, aby načetly a uložily data.
• Vně vaší aplikace váš backend volá API jiných firem: Stripe pro platby, poskytovatel e-mailu pro účtenky, poskytovatel AI modelu pro generování textu.

Když AI nástroj požádáte, aby „přijímal platby“ nebo „přidal AI shrnutí“, ve skutečnosti píše kód, který volá API. Znalost základů vám pomůže pochopit, co AI od vás potřebuje (obvykle účet u dané služby a API klíč), kde se může něco pokazit a kolik to bude stát.

Analogie z běžného života

Představte si restauraci. Nevcházíte do kuchyně a nevaříte. Přečtete si jídelní lístek, řeknete číšníkovi, co chcete, způsobem, kterému kuchyně rozumí, a číšník vám přinese jídlo — nebo vám řekne, že je jídlo vyprodané.

• Jídelní lístek je dokumentace API: seznam toho, co můžete požadovat, a jak.
• Číšník je API: jediný dohodnutý způsob, jak požadavky vcházejí a odpovědi vycházejí.
• Kuchyně je druhý systém: nemusíte vědět, jak funguje uvnitř.
• Vaše objednávka je požadavek; talíř je odpověď.

Kuchyně může změnit trouby a personál, aniž by to ovlivnilo vás, pokud zůstane jídelní lístek stejný. V tom je skutečná hodnota API: dvě systémy spolu mohou fungovat, aniž by ten druhý musel vědět, jak je postaven.

Jak funguje požadavek na webové API

Většina API, se kterými se setkáte, jsou webová API fungující přes HTTP, stejný protokol, jaký používá váš prohlížeč. Každý požadavek má několik částí:

A každá odpověď má:

JSON (JavaScript Object Notation) je jednoduchý textový formát se jmény a hodnotami ve složených závorkách. Je to standardní způsob, jakým webová API vyměňují data.

REST: nejběžnější styl

REST je široce používaná konvence pro návrh webových API. Každý typ věci má vlastní URL a standardní metody říkají, co s ní děláte. Takto by mohlo vypadat REST API pro rezervační aplikaci:

PUT také existuje a podle konvence nahrazuje celý záznam, zatímco PATCH mění jen pole, která pošlete.

Stavové kódy, které uvidíte nejčastěji:

Když se vaše aplikace rozbije, stavový kód je často nejrychlejší vodítko. 401 od poskytovatele plateb obvykle znamená chybějící nebo špatný API klíč; 429 znamená, že voláte příliš často.

REST není jediný styl — existují také GraphQL a API v RPC stylu — ale REST je to, co používá většina služeb a backendů vytvořených AI.

Příklad: potvrzení rezervace

Když zákazník v salonové aplikaci rezervuje střih, může se za sekundu nebo dvě odehrát několik volání API:

1. Stránka rezervace v prohlížeči pošle POST /api/bookings s službou, časem a údaji zákazníka na váš backend.
2. Váš backend zkontroluje, že termín je volný, uloží rezervaci do databáze a vrátí 201 Created.
3. Váš backend zavolá API poskytovatele e-mailu se svým tajným klíčem: „pošli toto potvrzení na lena@example.com.“
4. Pokud je záloha, váš backend požádá API poskytovatele plateb o vytvoření platební relace a pošle zákazníka tam.
5. Později poskytovatel plateb zavolá vaši aplikaci, aby oznámil, že platba proběhla. Toto zpětné volání je webhook.

První dva kroky jsou vaše vlastní API mezi frontendem a backendem. Kroky 3–5 jsou API třetích stran.

Běžné pojmy vysvětleny

Běžné chyby a omyly

• Tajné klíče ve frontendu. Cokoli v kódu, který běží v prohlížeči, může vidět každý, kdo návštěvu stránky. Tajné klíče musí zůstat na serveru, v proměnných prostředí nebo tajných klíčích.
• Vkládání klíčů do chatu. Historie chatu může být uložená. Místo toho použijte funkci tajných klíčů vašeho nástroje a každý klíč, který jste vystavili, zrotujte.
• Předpoklad, že API je zadarmo. Mnoho API účtuje za požadavek nebo za množství použití — API AI modelů účtují podle tokenů. Zkontrolujte ceny a nastavte limity útraty. Viz jak používat API LLM.
• Neřešení selhání. Externí služby vypadávají, mají timeouty a narážejí na limity. Požádejte o rozumné chybové hlášky a opakování.
• Důvěra v prohlížeč. Vaše vlastní API musí kontrolovat oprávnění samo. Skrytí tlačítka nezabrání tomu, aby někdo volal koncový bod přímo.
• Používání živých klíčů při testování. Až budete připraveni spustit, používejte klíče z testovacího režimu.

Co žádat od vašeho AI nástroje

• „Které externí API tato aplikace používá a kolik každé z nich stojí?“
• „Volej API plateb jen ze serveru. Klíč čti z proměnné prostředí.“
• „Vypiš každý koncový bod našeho API, co dělá a kdo ho smí volat.“
• „Na serveru zkontroluj, že přihlášený uživatel vlastní rezervaci, než ji upravíš nebo smažeš.“
• „Pokud API e-mailu selže, rezervaci přesto ulož a chybu zaloguj.“
• „Zatím používej testovací režim poskytovatele.“

API v Mythexu

Mythex může postavit vlastní API — jako součást webové aplikace, nebo jako samostatný backend v Node, Pythonu (FastAPI), C# nebo Javě běžící vedle vašeho frontendu — a napsat kód, který volá externí služby. Klíče těchto služeb přidáte jako tajné klíče projektu, ne do chatu, a vaše aplikace k nim má přístup v náhledu i po publikování. V dokumentaci najdete návody na integraci libovolného API a vytvoření REST API backendu.

Otázky