Čo je API? Jednoduchý sprievodca pre tvorcov aplikácií

API (application programming interface) je definovaný spôsob, ako jeden softvér žiada iný o dáta alebo o vykonanie akcie. Vaša aplikácia pošle požiadavku v dohodnutom formáte — „daj mi zajtrajšie rezervácie“, „strhni z tejto karty 20 €“, „zhrň tento text“ — a druhý systém pošle späť štruktúrovanú odpoveď. API sú spôsob, ako medzi sebou komunikujú časti aplikácie, a ako vaša aplikácia využíva externé služby, ako sú platby, e-mail, mapy a AI.

Prečo sú API dôležité pri tvorbe s AI

Takmer každá užitočná aplikácia sa skladá z častí, ktoré komunikujú cez API:

• Vo vnútri aplikácie obrazovky v prehliadači volajú API vášho vlastného backendu, aby načítali a uložili dáta.
• Mimo aplikácie váš backend volá API iných firiem: Stripe na prijímanie platieb, poskytovateľa e-mailov na odosielanie potvrdení, poskytovateľa modelov AI na generovanie textu.

Keď od AI buildera požiadate „prijímaj platby“ alebo „pridaj AI zhrnutie“, v skutočnosti sa píše kód, ktorý volá API. Základy vám pomôžu pochopiť, čo AI od vás potrebuje (zvyčajne účet u danej služby a API kľúč), kde sa môže niečo pokaziť a koľko to bude stáť.

Každodenné prirovnanie

Predstavte si reštauráciu. Nevchádzate do kuchyne a nevarí sa sami. Prečítate si jedálny lístok, poviete čašníkovi, čo chcete, spôsobom, ktorému kuchyňa rozumie, a čašník vám prinesie jedlo — alebo povie, že je jedlo vypredané.

• Jedálny lístok je dokumentácia API: zoznam toho, čo môžete požadovať a ako.
• Čašník je API: jediný dohodnutý spôsob, ako požiadavky vstupujú a odpovede vychádzajú.
• Kuchyňa je druhý systém: nemusíte vedieť, ako funguje vo vnútri.
• Vaša objednávka je požiadavka; tanier je odpoveď.

Kuchyňa môže zmeniť svoje rúry a personál bez toho, aby to ovplyvnilo vás, pokiaľ jedálny lístok zostane rovnaký. To je skutočná hodnota API: umožňuje dvom systémom spolupracovať, aniž by ktorýkoľvek z nich musel vedieť, ako je ten druhý postavený.

Ako funguje požiadavka na webové API

Väčšina API, s ktorými sa stretnete, sú webové API, ktoré fungujú cez HTTP, rovnaký protokol, akého používa váš prehliadač. Každá požiadavka má niekoľko častí:

A každá odpoveď má:

JSON (JavaScript Object Notation) je jednoduchý textový formát s menami a hodnotami v zložených zátvorkách. Je to štandardný spôsob, akým webové API vymieňajú dáta.

REST: najbežnejší štýl

REST je široko používaná konvencia na návrh webových API. Každý druh veci dostane vlastnú URL a štandardné metódy hovoria, čo sa s ňou robí. Takto by mohlo vyzerať REST API pre aplikáciu na rezervácie:

PUT tiež existuje a podľa konvencie nahradí celý záznam, zatiaľ čo PATCH mení len polia, ktoré pošlete.

Stavové kódy, ktoré uvidíte najčastejšie:

Keď sa vaša aplikácia pokazí, stavový kód je často najrýchlejšou stopou. 401 od poskytovateľa platieb zvyčajne znamená chýbajúci alebo nesprávny API kľúč; 429 znamená, že voláte príliš často.

REST nie je jediný štýl — existujú aj GraphQL a API v štýle RPC — ale REST je to, čo používa väčšina služieb a backendov vytvorených AI.

Praktický príklad: potvrdenie rezervácie

Keď zákazník v aplikácii pre kaderníctvo rezervuje strih, môže sa za sekundu-dve odohrať niekoľko volaní API:

1. Stránka rezervácie v prehliadači pošle POST /api/bookings s službou, časom a údajmi zákazníka na váš backend.
2. Váš backend skontroluje, či je termín voľný, uloží rezerváciu do databázy a vráti 201 Created.
3. Váš backend zavolá API poskytovateľa e-mailov s jeho tajným kľúčom: „pošli toto potvrdenie na lena@example.com.“
4. Ak sa vyžaduje záloha, váš backend požiada API poskytovateľa platieb o vytvorenie platobnej relácie a pošle zákazníka tam.
5. Neskôr vás poskytovateľ platieb zavolá, aby vám oznámil, že platba prebehla. Toto spätné volanie do vašej aplikácie je webhook.

Prvé dva kroky sú vaše vlastné API medzi frontendom a backendom. Kroky 3–5 sú API tretích strán.

Vysvetlenie bežných pojmov

Časté chyby a mylné predstavy

• Tajné kľúče vo frontende. Čokoľvek v kóde, ktorý beží v prehliadači, môže vidieť ktokoľvek, kto stránku navštívi. Tajné kľúče musia zostať na serveri, v premenných prostredia alebo tajomstvách.
• Vkladanie kľúčov do chatu. História chatu sa môže ukladať. Namiesto toho použite funkciu tajomstiev vášho buildera a každý kľúč, ktorý ste vystavili, obnovte.
• Predpoklad, že API je zadarmo. Mnohé API si účtujú poplatok za požiadavku alebo za množstvo použitia — API modelov AI účtujú podľa tokenov. Skontrolujte cenník a nastavte limity výdavkov. Pozri ako používať API LLM.
• Nepočítanie s chybami. Externé služby vypadávajú, majú timeouty a narážajú na limity. Požiadajte o rozumné chybové hlásenia a opakovania.
• Dôvera prehliadaču. Vaše vlastné API musí kontrolovať oprávnenia samo. Skrytie tlačidla nezabráni tomu, aby niekto volal endpoint priamo.
• Používanie živých kľúčov pri testovaní. Používajte testovacie kľúče, kým nebudete pripravení na spustenie.

Čo požiadať od svojho AI tvorcu

• „Ktoré externé API táto aplikácia používa a koľko stojí každé z nich?“
• „Volaj API platieb len zo servera. Kľúč načítaj z premennej prostredia.“
• „Vypíš každý endpoint nášho API, čo robí a kto ho smie volať.“
• „Na serveri over, že prihlásený používateľ vlastní rezerváciu, skôr než ju upravíš alebo zmažeš.“
• „Ak API e-mailov zlyhá, aj tak ulož rezerváciu a zaznamenaj chybu.“
• „Zatiaľ používaj testovací režim poskytovateľa.“

API v Mythex

Mythex dokáže vytvoriť vaše vlastné API — ako súčasť webovej aplikácie alebo ako samostatný backend v Node, Pythone (FastAPI), C# alebo Jave, bežiaci spolu s vaším frontendom — a napísať kód, ktorý volá externé služby. Kľúče API pridávate ako tajomstvá projektu, nie do chatu, a aplikácia ich má k dispozícii v náhľade aj po zverejnení. Dokumentácia obsahuje recepty na integráciu ľubovoľného API a backend s REST API.

Otázky