Miunganisho ya API

Miunganisho ya API ni kazi maalum za HTTP ambazo ejenti zako zinaweza kuita wakati wa mazungumzo — kutafuta oda, kuunda tiketi, kupata hali ya akaunti kutoka kwenye backend yako mwenyewe. Unafafanua endpoint mara moja chini ya Miunganisho → API (/dashboard/api-connections); ejenti zilizo na muunganisho huo zinaweza kisha kuuita wakati wowote mazungumzo yanapouhitaji.

Kuna njia mbili za kuunda mmoja: bandika kitu ambacho kisanidi kinaweza kuchanganua, au sanidi muunganisho mwenyewe.

Njia ya haraka: bandika na uchanganue

1. Bofya Muunganisho mpya wa API

   Dirisha la mazungumzo hufunguka kwenye kisanidi. Bandika mfano wa amri ya cURL, spec ya OpenAPI/Swagger, export ya Postman, kiolesura cha TypeScript, au skima ya Zod kwenye kisanduku.

2. Bofya Changanua

   ThunderPhone hutambua muunganisho mzima kutoka kwenye ulichobandika — URL, mbinu, vichwa, na skima ya vigezo inayotokana na vigezo vya query na mwili wa ombi ilivyopata. Vichwa ulivyobandika (ikiwa ni pamoja na vichwa vya uthibitishaji) huhifadhiwa kwenye usanidi wa endpoint.

3. Thibitisha sehemu zilizoangaziwa

   Usanidi uliotambuliwa hufunguka huku sehemu zilizokadiriwa zikiwa zimeangaziwa kwa ukaguzi. Rekebisha majina, maelezo, na aina za vigezo ili ejenti ielewe ni lini na jinsi ya kuita kazi hiyo — maelezo ndiyo ambayo modeli husoma.

4. Thibitisha na Uhifadhi

   Kuhifadhi kwanza huendesha ombi halisi la majaribio dhidi ya endpoint yako. Ikiwa ombi litashindwa, muunganisho hauhifadhiwi — rekebisha URL, vichwa vya uthibitishaji, au mwili wa ombi kisha ujaribu tena. Ukifaulu, muunganisho huhifadhiwa ukiwa na beji ya Imethibitishwa.

Ikiwa kisanidi hakiwezi kupata URL ya ombi kwenye ulichobandika, kitaeleza hivyo — jumuisha endpoint kamili ya http(s) kisha ujaribu tena.

Usanidi wa mwenyewe

Bofya Sanidi mwenyewe → kwenye kisanidi (au Unataka AI itambue hii? Jaribu Kisanidi → ili kurudi). Kijenzi cha usanidi wa mwenyewe kina vihariri viwili:

• Mwonekano — sehemu za fomu za jina la kuonyesha, jina la kazi, URL ya ombi, mbinu (POST, GET, PUT, PATCH, DELETE), vichwa maalum, na skima ya vigezo (Ongeza sifa kwa kila hoja ambayo ejenti inaweza kutoa).
• JSON — ufafanuzi huo huo kama JSON ghafi, kwa kubandika au kurekebisha kwa undani spec ya zana moja kwa moja.

Paneli ya Ombi la Jaribio (si ya lazima) hukuwezesha kutuma ombi lililosanidiwa kabla ya kuhifadhi na huonyesha hali, muda wa majibu, na onyesho la awali la jibu. Thibitisha na Uhifadhi huendesha jaribio hili kila wakati na huhifadhi tu likifaulu.

Dhibiti miunganisho yako

Kila mstari wa muunganisho unaonyesha hali yake ya uthibitishaji — Imethibitishwa, Haijajaribiwa, au Hitilafu — jina lake la kazi, na ejenti zinazoutumia. Kutoka kwenye menyu ya vitendo ya mstari unaweza:

• Hariri — fungua tena usanidi.
• Nakili — rudufu kama mwanzo wa kuanzia (nakala inaanza ikiwa Haijajaribiwa).
• Historia ya marekebisho — tazama matoleo ya awali na urejeshe moja kwenye kihariri.
• Hamisha — nakili au hamisha muunganisho kwenye shirika lingine unalomiliki uanachama. Kuhamisha huiondoa hapa; ejenti zilizoumia zinaweza kuhitaji kusanidiwa upya.
• Futa — ni ya kudumu; ejenti zinazotumia muunganisho zitahitaji kusanidiwa upya.

Iunganishe na ejenti

Ongeza muunganisho kwenye ejenti katika sehemu ya miunganisho ya API ya kijenzi (Jenga ejenti). Orodha inaonyesha ejenti zinazotumia kila muunganisho, hivyo unaweza kuona kwa haraka mabadiliko yanaathiri nini.

Hatua zinazofuata