Ody API 및 SDK 사용
모든 Ody 플랜에는 공개 REST API가 포함됩니다. 앱에서 키를 생성한 다음, API를 직접 호출하거나 공식 SDK를 설치하세요. 전체 참조, 가이드 및 예제는 이 도움말 센터가 아닌 개발자 사이트 — dev.ody.co — 에 있습니다.
API 키 생성
워크스페이스 관리자 또는 소유자여야 합니다.
- 설정 → 개발자 API를 엽니다 (휴대폰에서는 더보기 → 설정 → 개발자 API).
- 키 이름을 입력합니다 (예: "Zapier" 또는 "프로덕션 서버").
- 전체 액세스를 위해 모든 범위를 선택된 상태로 두거나, 키를 제한하기 위해 범위를 선택 해제합니다 (예: AI 어시스턴트용 읽기 전용 키).
- 키 유형에서 라이브 또는 테스트를 선택합니다.
- 키 생성을 클릭합니다.
- 배너 **"새 키를 지금 복사하세요. 다시 볼 수 없습니다."**에서 비밀을 복사합니다. Ody는 해시만 저장합니다. 비밀을 잃어버린 경우 키를 해지하고 새 키를 생성하세요.
키 목록에는 마스킹된 힌트(ody_live_…WXYZ 또는 ody_test_…WXYZ), 테스트 키용 테스트 배지, 범위, 그리고 키가 마지막으로 사용된 시점이 표시됩니다. 해지를 클릭하여 키를 즉시 비활성화합니다.
SDK 설치
공식 제로 종속성 클라이언트는 자동 페이지 매김, 유형화된 오류, 멱등성 전송 및 표준 웹훅 확인 기능을 갖춘 동일한 REST API를 래핑합니다.
| 언어 | 설치 | 문서 |
|---|---|---|
| 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 |
SDK 개요 또는 5분 퀵스타트부터 시작하세요. 일반 HTTP를 선호하시나요? 개발자 사이트의 모든 예제에는 cURL 탭이 있으며, 기계 판독 가능한 OpenAPI 사양은 api.ody.co/v1/api/openapi.json에 있습니다.
개발자 사이트의 다른 내용
| 주제 | 링크 |
|---|---|
| 인증, 범위, 라이브 vs 테스트 | Authentication |
| REST API 참조 | API overview |
| 아웃바운드 웹훅 (서명 확인, 이벤트 카탈로그) | Webhooks |
| MCP를 통해 ChatGPT 또는 Claude 연결 | MCP |
| 스위치보드 (AI로 통화 라우팅 계획 및 구축) | Switchboard |
동일한 API 키가 REST, SDK 및 MCP 서버를 구동합니다. 개발자 API 화면의 ChatGPT 및 Claude 연결 아래에 표시된 엔드포인트와 함께 MCP 클라이언트에 키를 붙여넣으세요.
문제 해결
- "API 키를 생성할 수 없습니다" — 워크스페이스의 관리자 또는 소유자여야 합니다. 소유자에게 승격을 요청하거나, 소유자가 키를 생성하도록 하세요.
- 비밀을 잃어버렸습니다 — 검색할 수 없습니다. 설정 → 개발자 API에서 키를 해지하고 새 키를 생성하세요.
- 코드에서 401 / 권한 없음 — 키가 의도한 대로 라이브인지 테스트인지, 해지되지 않았는지,
Authorization: Bearer …헤더가 전체 비밀(ody_live_또는ody_test_접두사 포함)을 사용하는지 확인하세요. - 403 범위 누락 — 키가 제한된 범위 세트로 생성되었습니다. 엔드포인트에 필요한 범위로 새 키를 생성하거나, 범위를 참조하세요.
- 코드 대신 Zapier / Make를 사용하고 싶습니다 — 많은 노코드 도구가 동일한 키로 REST API를 호출합니다. API 개요를 참조하세요. 내장된 CRM 및 헬프데스크 연결은 Ody는 어떤 통합을 지원하나요?에 있습니다.
관련 문서
자주 묻는 질문
개발자 문서는 어디에 있나요?
개발자를 위한 모든 정보는 https://dev.ody.co에 있습니다. REST API, 웹훅, MCP, 스위치보드, TypeScript 및 Python SDK가 포함됩니다. 도움말 센터에서는 앱에서 API 키를 생성하는 방법만 다룹니다.
Ody SDK는 어떻게 설치하나요?
TypeScript/JavaScript: npm install @ody-co/sdk. Python: pip install ody-sdk (import as ody). 둘 다 v0.6.0이며, 종속성이 없고 웹훅 확인 기능이 포함되어 있습니다.
누가 API 키를 생성할 수 있나요?
워크스페이스 관리자 또는 소유자입니다. **설정 → 개발자 API**를 엽니다 (휴대폰에서는 **더보기 → 설정 → 개발자 API**).
라이브 키와 테스트 키의 차이점은 무엇인가요?
라이브 키(ody_live_…)는 실제 문자를 보내고 실제 전화를 겁니다. 테스트 키(ody_test_…)는 실제 워크스페이스 데이터를 읽고 쓰지만 실제 문자를 보내지 않습니다. 전송은 시뮬레이션으로 기록됩니다. 개발 중에는 테스트 키를 사용하세요.