Hvað er API? Einfaldur leiðarvísir fyrir smiði appa

API (application programming interface) er skilgreind leið fyrir eitt hugbúnaðarkerfi til að biðja annað um gögn eða fá það til að gera eitthvað. Appið þitt sendir beiðni á umsömdu sniði — „gefðu mér bókanir morgundagsins“, „rukkaðu þetta kort um 20 evrur“, „dragðu saman þennan texta“ — og hitt kerfið sendir skipulagt svar til baka. API eru leiðin sem hlutar appsins tala saman, og leiðin sem appið þitt notar ytri þjónustur eins og greiðslur, tölvupóst, kort og AI.

Af hverju API skipta máli þegar þú smíðar með AI

Nánast hvert gagnlegt app er samsett úr hlutum sem tala saman í gegnum API:

• Innan appsins kalla skjáirnir í vafranum á eigin API bakendans til að hlaða og vista gögn.
• Utan appsins kallar bakendinn þinn á API annarra fyrirtækja: Stripe fyrir greiðslur, tölvupóstþjónustu fyrir kvittanir, AI-líkanaveitu fyrir texta.

Þegar þú biður AI-smíðatól um að „taka við greiðslum“ eða „bæta við AI-samantekt“ er það í raun að skrifa kóða sem kallar á API. Ef þú skilur grunnatriðin skilurðu betur hvað AI þarf frá þér (yfirleitt reikning hjá þeirri þjónustu og API-lykil), hvar hlutirnir geta farið úrskeiðis og hvað þeir kosta.

Hliðstæða úr daglegu lífi

Hugsaðu um veitingastað. Þú gengur ekki inn í eldhúsið og eldar. Þú lest matseðilinn, segir þjóninum hvað þú vilt á þann hátt sem eldhúsið skilur, og þjónninn kemur með matinn — eða segir þér að rétturinn sé uppseldur.

• Matseðillinn er API-skjölin: listi yfir það sem þú getur beðið um og hvernig.
• Þjónninn er API-ið: hin eina umsamda leið fyrir beiðnir inn og svör út.
• Eldhúsið er hitt kerfið: þú þarft ekki að vita hvernig það virkar að innan.
• Pöntunin þín er beiðnin; diskurinn er svarið.

Eldhúsið getur skipt um ofna og starfsfólk án þess að hafa áhrif á þig, svo lengi sem matseðillinn helst eins. Það er raunverulegt gildi API: það gerir tveimur kerfum kleift að vinna saman án þess að hvorugt þurfi að vita hvernig hitt er smíðað.

Hvernig vef-API beiðni virkar

Flest vef-API sem þú rekst á vinna yfir HTTP, sömu samskiptareglu og vafrinn þinn notar. Hver beiðni hefur nokkra hluta:

Og hvert svar hefur:

JSON (JavaScript Object Notation) er einfalt textasnið með nöfnum og gildum innan slaufusviga. Það er staðlaða leiðin fyrir vef-API til að skiptast á gögnum.

REST: algengasti stíllinn

REST er víðtækt samkomulag um hönnun vef-API. Hver tegund hluta fær sína eigin vefslóð og staðlaðar aðgerðir segja til um hvað þú ert að gera við hana. Hér er hvernig REST API fyrir bókunarapp gæti litið út:

PUT er líka til og skiptir venjulega út allri færslunni, en PATCH breytir aðeins þeim reitum sem þú sendir.

Stöðukóðar sem þú sérð oftast:

Þegar appið þitt bilar er stöðukóðinn oft fljótlegasta vísbendingin. 401 frá greiðslugátt þýðir yfirleitt að API-lykill vantar eða er rangur; 429 þýðir að þú kallar of oft.

REST er ekki eini stíllinn — GraphQL og RPC-stíl API eru líka til — en REST er það sem flestar þjónustur og AI-smíðaðir bakendar nota.

Dæmi: staðfesting á bókun

Þegar viðskiptavinur bókar klippingu í hársnyrtiappi geta nokkur API-köll átt sér stað á einni eða tveimur sekúndum:

1. Bókunarsíðan í vafranum sendir POST /api/bookings með þjónustu, tíma og upplýsingum um viðskiptavininn á bakendann þinn.
2. Bakendinn þinn athugar hvort tíminn sé laus, vistar bókunina í gagnagrunninum og skilar 201 Created.
3. Bakendinn þinn kallar á API tölvupóstþjónustu með leynilega lyklinum sínum: „sendu þessa staðfestingu á lena@example.com.“
4. Ef um innborgun er að ræða biður bakendinn þinn API greiðslugáttarinnar um að búa til greiðslulotu og sendir viðskiptavininn þangað.
5. Síðar hringir greiðslugáttin í appið þitt til að segja að greiðslan hafi heppnast. Þetta öfuga símtal er webhook.

Fyrstu tvö skrefin eru þitt eigið API milli framenda og bakenda. Skref 3–5 eru API frá þriðja aðila.

Algeng hugtök útskýrð

Algeng mistök og misskilningur

• Að setja leynilega lykla í framendann. Allt í kóða sem keyrir í vafranum getur hver sem er heimsótt séð. Leynilegir lyklar verða að vera á þjóninum, í umhverfisbreytum eða leyndarmálum.
• Að líma lykla í spjallið. Spjallsagan gæti verið geymd. Notaðu leyndarmálseiginleika smíðatólsins í staðinn, og skiptu um alla lykla sem þú hefur afhjúpað.
• Að gera ráð fyrir að API sé ókeypis. Mörg API rukka fyrir hverja beiðni eða notkunareiningu — API fyrir AI-líkön rukka eftir táknum. Athugaðu verðlagningu og settu eyðslumörk. Sjá hvernig þú notar LLM API.
• Að meðhöndla ekki bilanir. Ytri þjónustur detta út, renna út á tíma og rekast á mörk. Biddu um skynsamleg villuboð og endursendingar.
• Að treysta vafranum. API-ið þitt verður sjálft að athuga heimildir. Að fela hnapp stöðvar ekki einhvern sem kallar beint á endapunktinn.
• Að nota raunverulega lykla í prófunum. Notaðu prófunarlykla þar til þú ert tilbúin/n að setja appið í loftið.

Hvað þú átt að biðja AI-smíðatólið um

• „Hvaða ytri API notar þetta app, og hvað kostar hvert þeirra?“
• „Kallaðu á greiðslu-API aðeins frá þjóninum. Lestu lykilinn úr umhverfisbreytu.“
• „Listaðu sérhvern endapunkt í API-inu okkar, hvað hann gerir og hver má kalla á hann.“
• „Athugaðu á þjóninum að innskráði notandinn eigi bókunina áður en hún er uppfærð eða eydd.“
• „Ef tölvupóst-API bilar, vistaðu bókunina samt og skráðu villuna.“
• „Notaðu prófunarham veitandans í bili.“

API í Mythex

Mythex getur smíðað þitt eigið API — sem hluta af vefappi, eða sem sérstakan bakenda í Node, Python (FastAPI), C# eða Java sem keyrir við hliðina á framendanum þínum — og skrifað kóðann sem kallar á þjónustur utan appsins. Þú bætir lyklum þeirra við sem leyndarmál verkefnisins í stað þess að setja þá í spjallið, og þeir eru aðgengilegir appinu þínu í forskoðun og þegar það er birt. Skjölin eru með uppskriftir fyrir tengingu við hvaða API sem er og smíði REST API-bakenda.

Spurningar