Sanggunian ng API para sa mga developer
Ikonekta ang sarili mong app sa workspace mo: ang REST API, mga key at scope nito, mga error, limitasyon sa bilis at mga webhook.
Saan ito makikita
⚙️ Mga Setting › Sanggunian ng API · Home page › Mga resource › Sanggunian ng API
Buksan ang screen na ito
Mga hakbang
- Buksan ang “Sanggunian ng API” sa sidebar, o ang “Sanggunian ng API” sa menu ng “Mga resource” ng home page.
- Magsimula sa “Magsimula rito”: “Base URL at mga kumbensiyon”, “Pagpapatotoo” at “Mga scope”.
- Hanapin ang “Mga endpoint” ayon sa grupo; ipinapakita ng bawat isa ang mga parameter, request body, response at mga error nito na may halimbawa.
- Basahin ang “Mga error at status code”, “Mga limitasyon sa bilis” at “Mga webhook (palabas)” bago mag-live. Dina-download ng “OpenAPI JSON” ang buong espesipikasyon.
Pag-aayos ng problema
Paano kumuha ng API key?
Inilalabas ang mga key para sa workspace mo kapag hiniling; hindi pa ito magagawa sa app. Nakalista ang mga key ng workspace mo sa pahina ng developer ng AI area, kung saan ang mga namamahala ng workspace ay puwede ring magdagdag at sumubok ng mga webhook endpoint.
Mga tip
- Tawagin ang API mula lang sa server mo. Huwag maglagay ng key sa web page o mobile app.
Magandang malaman
- Mababasa ang sanggunian ng API nang hindi nagsa-sign in.
Mga kaugnay na how-to
- Paano maghanap ng endpoint at kopyahin ang halimbawa? Maghanap sa sanggunian ng API, tumalon sa isang endpoint, at kopyahin ang halimbawa o link nito.
- Paano basahin ang mga karaniwang tanong (Dokumentasyon)? Magbasa ng maiikling sagot tungkol sa ginagawa ng produkto ngayon: pagsisimula, mga wika at boses, test call, numero ng telepono, mga plano at account.
- Mga kakayahan Ang kumpletong katalogo ng mga kakayahan ng call center, bawat isa ay tapat na minarkahan bilang naipadala o plinano.