Gamitin ang Ody API at SDKs
Bawat Ody plan ay kasama ang pampublikong REST API. Gumawa ng key sa app, pagkatapos ay direktang tawagan ang API o i-install ang isang opisyal na SDK. Ang kumpletong reference, mga gabay at halimbawa ay nasa developer site — dev.ody.co — hindi sa help center na ito.
Gumawa ng API key
Dapat ikaw ay isang workspace admin o ang may-ari.
- Buksan ang Settings → Developer API (sa telepono: More → Settings → Developer API).
- Mag-type ng Pangalan ng key (halimbawa "Zapier" o "Production server").
- Iwanang nakapili ang bawat scope para sa buong access, o i-deselect ang mga scope upang limitahan ang key (halimbawa, isang read-only key para sa isang AI assistant).
- Sa ilalim ng Uri ng key, piliin ang Live o Test.
- I-click ang Gumawa ng key.
- Kopyahin ang secret mula sa banner na "Kopyahin ang iyong bagong key ngayon — hindi mo na ito makikita muli." Ang Ody ay nag-iimbak lamang ng hash — kung mawala mo ang secret, bawiin ang key at gumawa ng bago.
Ang listahan ng key ay nagpapakita ng masked hint (ody_live_…WXYZ o ody_test_…WXYZ), isang Test badge para sa test keys, ang mga scope, at kung kailan huling ginamit ang key. I-click ang Bawiin upang agad na i-disable ang isang key.
I-install ang isang SDK
Ang mga opisyal na zero-dependency client ay bumabalot sa parehong REST API, na may auto-pagination, typed errors, idempotent sends at Standard Webhooks verification:
| Wika | I-install | Mga Dokumento |
|---|---|---|
| TypeScript / JavaScript | npm install @ody-co/sdk |
dev.ody.co/sdks/typescript |
| Python | pip install ody-sdk (import as ody) |
dev.ody.co/sdks/python |
Magsimula sa pangkalahatang-ideya ng SDK o sa 5-minutong quickstart. Mas gusto ang plain HTTP? Bawat halimbawa sa developer site ay may cURL tab, at ang machine-readable OpenAPI spec ay nasa api.ody.co/v1/api/openapi.json.
Ano pa ang nasa developer site
| Paksa | Link |
|---|---|
| Authentication, mga scope, Live vs Test | Authentication |
| REST API reference | API overview |
| Outbound webhooks (i-verify ang mga signature, catalog ng event) | Webhooks |
| Ikonekta ang ChatGPT o Claude sa pamamagitan ng MCP | MCP |
| Switchboard (magplano at bumuo ng call routing gamit ang AI) | Switchboard |
Ang parehong API key ang nagpapagana sa REST, mga SDK at ang MCP server. Idikit ang isang key sa isang MCP client gamit ang endpoint na ipinapakita sa ilalim ng Ikonekta sa ChatGPT & Claude sa screen ng Developer API.
Pag-troubleshoot
- "Hindi makagawa ng API key" — kailangan mong maging isang admin o ang may-ari ng workspace. Hilingin sa may-ari na i-promote ka, o ipagawa sa kanila ang key.
- Nawala ang secret — hindi mo ito mababawi. Bawiin ang key sa Settings → Developer API at gumawa ng bago.
- 401 / unauthorized mula sa iyong code — suriin kung ang key ay Live vs Test ayon sa iyong intensyon, na hindi ito nabawi, at na ang
Authorization: Bearer …header ay gumagamit ng buong secret (kasama angody_live_oody_test_prefix). - 403 nawawalang scope — ang key ay ginawa na may pinababang set ng mga scope. Gumawa ng bagong key na may mga scope na kailangan ng iyong endpoint, o tingnan ang Mga Scope.
- Gusto ng Zapier / Make sa halip na code — maraming no-code tool ang tumatawag sa REST API gamit ang parehong key; tingnan ang pangkalahatang-ideya ng API. Ang mga built-in na koneksyon sa CRM at helpdesk ay nasa ilalim ng Anong mga integrasyon ang sinusuportahan ng Ody?.
Mga kaugnay na artikulo
Mga madalas itanong
Nasaan ang mga dokumento ng developer?
Lahat ng kailangan ng mga developer ay nasa https://dev.ody.co — REST API, webhooks, MCP, Switchboard, at ang TypeScript at Python SDKs. Ang help center na ito ay sumasaklaw lamang sa paggawa ng iyong API key sa app.
Paano ko i-install ang Ody SDK?
TypeScript/JavaScript: npm install @ody-co/sdk. Python: pip install ody-sdk (import as ody). Pareho silang nasa v0.6.0, walang dependencies, at kasama ang webhook verification.
Sino ang maaaring gumawa ng API key?
Isang workspace admin o ang may-ari. Buksan ang **Settings → Developer API** (sa telepono: **More → Settings → Developer API**).
Ano ang pagkakaiba ng Live at Test keys?
Ang Live keys (ody_live_…) ay nagpapadala ng totoong text at tumatawag nang totoo. Ang Test keys (ody_test_…) ay nagbabasa at nagsusulat ng totoong data ng workspace ngunit hindi kailanman nagpapadala ng totoong text — ang mga pinadala ay naitatala bilang simulated. Gamitin ang Test habang ikaw ay nagtatayo.