Kas ir API? Vienkāršs ceļvedis lietotņu veidotājiem

API (lietojumprogrammu programmēšanas saskarne) ir noteikts veids, kā viena programmatūras daļa pieprasa datus no citas vai liek tai kaut ko izdarīt. Jūsu lietotne nosūta pieprasījumu vienotā formātā — „dod man rītdienas rezervācijas”, „iekasē 20 € no šīs kartes”, „apkopo šo tekstu” — un otra sistēma atsūta strukturētu atbildi. API ir veids, kā lietotnes daļas savstarpēji runā, un kā jūsu lietotne izmanto ārējus pakalpojumus, piemēram, maksājumus, e-pastu, kartes un AI.

Kāpēc API ir svarīgi, veidojot ar AI

Gandrīz katra noderīga lietotne sastāv no daļām, kas sazinās caur API:

• Lietotnes iekšienē ekrāni pārlūkprogrammā izsauc jūsu pašu aizmugures API, lai ielādētu un saglabātu datus.
• Ārpus lietotnes jūsu aizmugure izsauc citu uzņēmumu API: Stripe maksājumu pieņemšanai, e-pasta pakalpojumu kvītīm, AI modeļa nodrošinātāju teksta ģenerēšanai.

Kad lūdzat AI veidotāju „pieņemt maksājumus” vai „pievienot AI kopsavilkumu”, tas patiesībā raksta kodu, kas izsauc API. Pamatu izpratne palīdz saprast, ko AI no jums vajag (parasti kontu pie šī pakalpojuma un API atslēgu), kur var rasties problēmas un cik tas maksās.

Ikdienas salīdzinājums

Domājiet par restorānu. Jūs neejat virtuvē gatavot. Jūs izlasāt ēdienkarti, pasakāt viesmīlim, ko vēlaties veidā, ko virtuve saprot, un viesmīlis atnes jūsu ēdienu — vai pasaka, ka ēdiens ir beidzies.

• Ēdienkarte ir API dokumentācija: saraksts ar to, ko var pieprasīt un kā.
• Viesmīlis ir API: viens saskaņots veids, kā pieprasījumi ienāk un atbildes iziet.
• Virtuve ir otra sistēma: jums nav jāzina, kā tā darbojas iekšēji.
• Jūsu pasūtījums ir pieprasījums; šķīvis ir atbilde.

Virtuve var mainīt savas krāsnis un personālu, neietekmējot jūs, tik ilgi, kamēr ēdienkarte paliek tāda pati. Tā ir API īstā vērtība: tas ļauj divām sistēmām strādāt kopā, nevienai nevajagot zināt, kā otra ir veidota.

Kā darbojas tīmekļa API pieprasījums

Vairums API, ar ko sastapsieties, ir tīmekļa API, kas darbojas pār HTTP — to pašu protokolu, ko izmanto jūsu pārlūkprogramma. Katram pieprasījumam ir vairākas daļas:

Un katrai atbildei ir:

JSON (JavaScript Object Notation) ir vienkāršs teksta formāts ar nosaukumiem un vērtībām figūriekavās. Tas ir standarta veids, kā tīmekļa API apmainās ar datiem.

REST: visizplatītākais stils

REST ir plaši izmantota konvencija tīmekļa API projektēšanai. Katram objekta tipam ir sava URL, un standarta metodes saka, ko ar to darāt. Šeit ir, kā varētu izskatīties REST API rezervāciju lietotnei:

PUT arī eksistē un parasti aizstāj visu ierakstu, savukārt PATCH maina tikai nosūtītos laukus.

Visbiežāk redzamie statusa kodi:

Kad jūsu lietotne nedarbojas, statusa kods bieži ir ātrākais pavediens. 401 no maksājumu sniedzēja parasti nozīmē trūkstošu vai nepareizu API atslēgu; 429 nozīmē, ka zvanāt pārāk bieži.

REST nav vienīgais stils — pastāv arī GraphQL un RPC stila API —, bet REST ir tas, ko izmanto lielākā daļa pakalpojumu un AI veidotu aizmugures.

Praktisks piemērs: rezervācijas apstiprinājums

Kad klients frizētavas lietotnē rezervē griezienu, dažu sekunžu laikā var notikt vairāki API izsaukumi:

1. Rezervācijas lapa pārlūkprogrammā nosūta POST /api/bookings ar pakalpojumu, laiku un klienta datiem uz jūsu aizmuguri.
2. Jūsu aizmugure pārbauda, vai laiks ir brīvs, saglabā rezervāciju datubāzē un atgriež 201 Created.
3. Jūsu aizmugure izsauc e-pasta sniedzēja API ar savu slepeno atslēgu: „nosūti šo apstiprinājumu uz lena@example.com.”
4. Ja ir depozīts, jūsu aizmugure lūdz maksājumu sniedzēja API izveidot norēķina sesiju un nosūta klientu tajā.
5. Vēlāk maksājumu sniedzējs izsauc jūsu lietotni, lai pateiktu, ka maksājums ir veiksmīgs. Šis apgrieztais izsaukums ir webhook.

Pirmie divi soļi ir jūsu pašu API starp priekšgalu un aizmuguri. Soļi 3–5 ir trešo pušu API.

Izplatītāko terminu skaidrojums

Biežākās kļūdas un nepareizi priekšstati

• Slepenu atslēgu ievietošana priekšgalā. Viss kods, kas darbojas pārlūkprogrammā, ir redzams ikvienam, kas apmeklē vietni. Slepenām atslēgām jāpaliek serverī, vides mainīgajos vai noslēpumos.
• Atslēgu ielīmēšana tērzēšanā. Tērzēšanas vēsture var tikt glabāta. Izmantojiet savu veidotāja noslēpumu funkciju un nomainiet jebkuru atslēgu, kas ir nonākusi atklātībā.
• Pieņemt, ka API ir bezmaksas. Daudzi API maksā par pieprasījumu vai par lietojuma vienību — AI modeļu API maksā par žetoniem. Pārbaudiet cenas un iestatiet tēriņu ierobežojumus. Skatiet kā izmantot LLM API.
• Kļūmju neapstrāde. Ārējie pakalpojumi nedarbojas, iestrēgst un sasniedz ierobežojumus. Lūdziet saprātīgus kļūdu ziņojumus un atkārtojumus.
• Uzticēšanās pārlūkprogrammai. Jūsu pašu API pats jāpārbauda atļaujas. Pogas paslēpšana neaptur kādu, kas zvana galapunktam tieši.
• Īstu atslēgu izmantošana testēšanā. Testēšanai izmantojiet testa režīma atslēgas, līdz esat gatavi palaist.

Ko prasīt savam AI veidotājam

• „Kuri ārējie API izmanto šī lietotne un cik maksā katrs no tiem?”
• „Izsauciet maksājumu API tikai no servera. Nolasiet atslēgu no vides mainīgā.”
• „Uzskaitiet katru mūsu API galapunktu, ko tas dara un kam ir atļauts to izsaukt.”
• „Pārbaudiet serverī, vai pieteikušais lietotājs īpašnieks ir rezervācijai, pirms to atjauno vai dzēš.”
• „Ja e-pasta API neizdodas, tomēr saglabājiet rezervāciju un reģistrējiet kļūdu.”
• „Pagaidām izmantojiet sniedzēja testa režīmu.”

API Mythex

Mythex var veidot jūsu pašu API — kā daļu no tīmekļa lietotnes vai kā atsevišķu aizmuguri Node, Python (FastAPI), C# vai Java, kas darbojas blakus jūsu priekšgalam — un rakstīt kodu, kas izsauc ārējos pakalpojumus. API atslēgas pievienojat kā projekta noslēpumus, nevis tērzēšanā, un tās ir pieejamas jūsu lietotnei priekšskatījumā un pēc publicēšanas. Dokumentācijā ir receptes jebkura API integrēšanai un REST API aizmugures veidošanai.

Jautājumi