Miunganisho ya API

Geuza API yoyote ya HTTP kuwa function ambayo ejenti wako anaweza kuita katikati ya mazungumzo: bandika amri ya cURL, na wizard itaunda ufafanuzi wa tool, vigezo na uthibitishaji.

Miunganisho ya API ni kazi maalum za HTTP ambazo ejenti wako wanaweza kuita wakati wa mazungumzo — kutafuta agizo, kuunda tiketi, kuchukua hali ya akaunti kutoka kwenye backend yako mwenyewe. Unafafanua anwani ya API mara moja chini ya Miunganisho → API (/dashboard/api-connections); ejenti ambao muunganisho umeambatishwa kwao wanaweza kuuita wakati wowote mazungumzo yanapouhitaji.

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

Njia ya haraka: bandika na uchanganue#

1. Bofya Muunganisho mpya wa API

   Kisanduku cha mazungumzo hufunguka kwenye kisanidi. Bandika sampuli ya amri ya cURL, spec ya OpenAPI/Swagger, usafirishaji wa Postman, kiolesura cha TypeScript, au schema ya Zod kwenye kisanduku.

2. Bofya Changanua

   ThunderPhone hutambua muunganisho mzima kutoka kwenye ulichobandika — URL, mbinu, vichwa, na schema ya vigezo inayotokana na vigezo vya hoja za URL na mwili wa ombi uliopatikana. Vichwa ulivyobandika (ikiwemo vichwa vya uthibitishaji) huongezwa kwenye usanidi wa anwani ya API.

3. Thibitisha sehemu zilizoangaziwa

   Usanidi unaotambuliwa hufunguka huku sehemu zilizokadiriwa zikiwa zimeangaziwa kwa ukaguzi. Rekebisha majina, maelezo, na aina za vigezo ili ejenti aelewe wakati na jinsi ya kuita kazi — maelezo ndiyo modeli husoma.

4. Thibitisha na Uhifadhi

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

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

Usanidi wa mkono#

Bofya Sanidi mwenyewe → kwenye kisanidi (au Je, unataka AI itambue haya? Jaribu Kisanidi → kurudi). Kijenzi cha usanidi wa mkono kina vihariri viwili:

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

Paneli ya Jaribu Ombi (si lazima) hukuruhusu kutuma ombi lililosanidiwa kabla ya kuhifadhi na huonyesha hali, ucheleweshaji, na hakikisho la jibu. Thibitisha na Uhifadhi huendesha jaribio hili kila wakati na huhifadhi tu likifanikiwa.

Dhibiti miunganisho yako#

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

• Hariri — fungua tena usanidi.
• Nakili — irudufu kama sehemu ya kuanzia (nakala huanza ikiwa Haijajaribiwa).
• Historia ya marekebisho — tazama matoleo ya awali na urejeshe moja kwenye kihariri.
• Hamisha — nakili au hamisha muunganisho hadi shirika lingine unaloshiriki. Kuhamisha huiondoa hapa; ejenti walioutumia wanaweza kuhitaji kusanidiwa upya.
• Futa — ni ya kudumu; ejenti wanaotumia muunganisho watahitaji kusanidiwa upya.

Uambatishe kwa ejenti#

Ongeza muunganisho kwa ejenti katika sehemu ya miunganisho ya API ya kijenzi (Jenga ejenti). Orodha huonyesha ejenti wanaotumia kila muunganisho, ili uweze kuona kwa haraka mabadiliko yanaathiri nini.

Hatua zinazofuata#