Ano ang SDK? Software Development Kits, Ipinaliwanag nang Simple

Ang SDK (software development kit) ay handang gamitin na toolkit na ibinibigay ng isang kumpanya sa developers para magamit nila ang serbisyo o platform nito nang hindi kailangang gawin ang lahat mula sa simula. Karaniwan itong may code library para sa isang partikular na programming language, dokumentasyon at mga halimbawa, at kung minsan ay dagdag na tools gaya ng testing utilities. Kapag sinabing “gumagamit ang app ng Stripe SDK,” ibig sabihin, tinatawag ng code mo ang mga function na handa na ng Stripe sa halip na isulat nang manwal ang bawat request sa API ng Stripe.

Bakit mahalaga ang SDK kapag gumagawa ka gamit ang AI

Kapag humiling ka sa AI builder na magdagdag ng payments, AI chat, maps o email, kadalasan ay ii-install nito ang SDK ng provider na iyon at magsusulat ng ilang linya para tawagin ito. Makakatulong na alam mo kung ano ang SDK para:

• Maintindihan kung ano ang idinadagdag sa project mo. Ang SDK ay dependency, isang external na code na umaasa na ngayon ang app mo.
• Makita ang setup na kailangan nito. Halos bawat SDK ay nangangailangan ng API key, at marami ang may magkahiwalay na “server” at “browser” na bersyon na may magkaibang patakaran kung aling mga key ang ligtas gamitin.
• Humiling ng tamang bagay. Mas malinaw ang “gamitin ang opisyal na Stripe SDK sa server” kaysa sa “idagdag ang Stripe.”
• Basahin ang mga error. Maraming error sa app na gawa ng AI ang galing sa SDK na mali ang setup, luma, o nagamit sa maling lugar.

Isang halimbawang pang-araw-araw

Isipin mong gusto mong magkabit ng mga estante.

• Ang API ay ang mga patakaran ng gusali: aling pader ang kayang tumanggap ng turnilyo, gaano kabigat ang kaya nila, at saan ang mga tubo. Kaya mong sundin ang mga patakarang iyon lamang, sinusukat at binabarena ang lahat nang mag-isa.
• Ang SDK ay ang flat-pack na kit ng estante galing sa parehong kumpanyang gumawa ng mga pader: nakaputol nang mga piyesa, tamang turnilyo, bracket na eksaktong akma sa kanilang pader, at instruction booklet.

Ikaw pa rin ang magpapasya kung saan ilalagay ang estante at ano ang ilalagay dito. Tinitipid ka lang ng kit sa pagputol ng kahoy at paghula sa laki ng turnilyo, at mas malabong may mabutas na tubo.

SDK vs API vs library vs framework

Nagkakapatong ang mga terminong ito, kaya nalilito ang maraming tao:

Kadalasang naglalaman ng library ang isang SDK, at karaniwang tinatawag ng library na iyon ang isang API. Para sa web service, madalas na nagagamit nang palitan ang “SDK” at “client library.”

May mga SDK na hindi tungkol sa web services. Naglalathala ang Apple at Google ng SDK para sa paggawa ng iOS at Android app, na kasama ang compilers, simulators at platform code. Pareho ang ideya: lahat ng kailangan mo para gumawa para sa kanilang platform, nasa iisang kit.

Ano ang nagagawa ng SDK para sa iyo

Narito ang parehong gawain, ang paggawa ng customer sa payment provider, sa dalawang paraan.

Kung walang SDK, kailangang buuin ng code mo mismo ang HTTP request: itakda ang URL, ilagay ang secret key sa tamang header, i-format ang data ayon sa inaasahan ng API, ipadala, suriin ang status code, i-parse ang response, at humawak ng retries kapag may pumalyang network.

Kung may SDK, halos isang linya lang:

const customer = await stripe.customers.create({ email: "lena@example.com" });

Sa likod ng linyang iyon, inaasikaso ng SDK ang:

• Authentication: tamang paglakip ng key mo sa bawat request
• Data formatting: pag-convert ng data mo sa hinihingi ng API, at ng response pabalik sa objects
• Errors: pag-convert ng status codes sa malinaw na error types na mahuhuli ng code mo
• Retries: pag-ulit nang ligtas kapag pumalya ang request dahil sa pansamantalang dahilan (maraming opisyal na SDK ang ginagawa ito)
• Types: sa TypeScript, sinasabi sa editor mo kung aling fields ang umiiral, kaya lumalabas ang mga pagkakamali bago mo patakbuhin ang code

Isang halimbawang gawa: pagdagdag ng AI replies sa support app

Hiniling mo sa AI builder: “Kapag nagsumite ang customer ng support ticket, gumawa ng iminumungkahing reply gamit ang AI model.”

1. Ii-install ng AI ang opisyal na SDK ng model provider bilang package sa project mo (sa JavaScript projects, mula sa npm registry).
2. Idadagdag mo ang API key ng provider bilang project secret. Babasahin ito ng SDK mula sa environment variable sa server.
3. Susulat ang AI ng server route na tatawag sa SDK gamit ang ticket text at maikling instruksyon, at ise-save ang iminumungkahing reply sa database.
4. Hindi kailanman makikita ng browser ang key; tatawag lang ito sa sarili mong server route.

Kung babaguhin ng provider ang API nila sa hinaharap, karaniwang maglalabas sila ng bagong bersyon ng SDK. Kadalasan, sapat na ang pag-update ng package, at ang pagsuri sa release notes para sa breaking changes.

Mahahalagang termino

Mga karaniwang maling akala

• “Iisa ang SDK at API.” Ang API ang interface ng serbisyo; ang SDK ay convenience layer sa ibabaw nito. Maaari mong tawagin ang karamihan ng web APIs nang walang SDK, mas marami lang ang trabaho.
• “Kapag naka-install na ang SDK, tapos na ang integration.” Kailangan mo pa rin ng account sa provider, tamang keys, at code na humahawak sa mga nangyayari kapag pumalya ang mga bagay.
• “Ang anumang package na may tamang pangalan ay ang opisyal.” Minsan, naglalathala ang mga attacker ng magkakamukhang package. Tingnan sa docs ng provider ang eksaktong pangalan ng package.
• “Puwedeng gamitin ng browser SDK ang secret key ko.” Hindi kailanman. Anumang nasa browser code ay nakikita ng bisita. Ang secret keys ay para lang sa server-side code. Tingnan ang paano panatilihing ligtas ang API keys.
• “Hindi kailangang i-update ang SDK.” Tumitigil sa pagtanggap ng ayos ang lumang bersyon, at kalaunan ay hihinto na sa paggana kapag itinigil na ng provider ang lumang API version.

Ano ang itatanong sa AI builder mo

• “Gamitin ang opisyal na SDK ng provider, hindi third-party wrapper. Sabihin mo sa akin ang eksaktong pangalan ng package at bersyon na in-install mo.”
• “Gamitin ang SDK sa server lang, at basahin ang key mula sa environment variable.”
• “Aling bahagi ng SDK na ito ang tumatakbo sa browser, at aling keys ang gamit nila?”
• “Ano ang mangyayari kung pumalya o mag-timeout ang tawag sa SDK? Magpakita ng malinaw na mensahe sa user at mag-log ng error.”
• “Ilista ang bawat SDK at package na nakasalalay ang app na ito, at ipaliwanag sa simpleng Ingles kung para saan ang bawat isa.”
• “I-check kung may alinman sa mga SDK natin na luma na o may kilalang security issue.”

SDK sa Mythex

Maaaring mag-install ang Mythex agent ng packages sa sandbox ng project mo gamit ang karaniwang package manager ng stack mo, kasama ang SDK ng mga provider. Banggitin lang ang package at ang feature na gusto mo rito. Tingnan ang Using npm packages. Hindi nagbibigay ang Mythex ng katalogo ng handang integrations para sa app mo: ilalagay mo ang key ng provider bilang project secret at hihilingin mong tawagin ng agent ang serbisyo mula sa server side, gaya ng inilarawan sa Integrate any API.

Para sa layer sa ilalim ng SDK, basahin ang ano ang API. Para sa dalawang karaniwang feature na gumagamit ng SDK, tingnan ang paano magdagdag ng payments sa app mo at paano gamitin ang LLM APIs.

Mga tanong