Sử dụng Ody API và SDK
Mọi gói Ody đều bao gồm REST API công khai. Tạo khóa trong ứng dụng, sau đó gọi API trực tiếp hoặc cài đặt SDK chính thức. Tài liệu tham khảo đầy đủ, hướng dẫn và ví dụ có trên trang web dành cho nhà phát triển — dev.ody.co — không có trong trung tâm trợ giúp này.
Tạo khóa API
Bạn phải là quản trị viên không gian làm việc hoặc chủ sở hữu.
- Mở Cài đặt → API Nhà phát triển (trên điện thoại: Thêm → Cài đặt → API Nhà phát triển).
- Nhập Tên khóa (ví dụ "Zapier" hoặc "Máy chủ sản xuất").
- Để mọi phạm vi được chọn để có toàn quyền truy cập, hoặc bỏ chọn các phạm vi để giới hạn khóa (ví dụ: khóa chỉ đọc cho trợ lý AI).
- Trong mục Loại khóa, chọn Live hoặc Test.
- Nhấp vào Tạo khóa.
- Sao chép bí mật từ biểu ngữ "Sao chép khóa mới của bạn ngay bây giờ — bạn sẽ không thấy nó nữa." Ody chỉ lưu trữ một hàm băm — nếu bạn mất bí mật, hãy thu hồi khóa và tạo một khóa mới.
Danh sách khóa hiển thị một gợi ý được che giấu (ody_live_…WXYZ hoặc ody_test_…WXYZ), một huy hiệu Test cho các khóa thử nghiệm, các phạm vi, và thời điểm khóa được sử dụng lần cuối. Nhấp vào Thu hồi để vô hiệu hóa khóa ngay lập tức.
Cài đặt SDK
Các client chính thức không phụ thuộc nào gói gọn cùng một REST API, với phân trang tự động, lỗi được định kiểu, gửi idempotent và xác minh Webhooks tiêu chuẩn:
| Ngôn ngữ | Cài đặt | Tài liệu |
|---|---|---|
| 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 |
Bắt đầu với tổng quan SDK hoặc hướng dẫn nhanh 5 phút. Bạn thích HTTP thuần túy hơn? Mọi ví dụ trên trang web dành cho nhà phát triển đều có tab cURL, và đặc tả OpenAPI có thể đọc được bằng máy có tại api.ody.co/v1/api/openapi.json.
Những gì khác có trên trang web dành cho nhà phát triển
| Chủ đề | Liên kết |
|---|---|
| Xác thực, phạm vi, Live so với Test | Authentication |
| Tham chiếu REST API | API overview |
| Webhooks gửi đi (xác minh chữ ký, danh mục sự kiện) | Webhooks |
| Kết nối ChatGPT hoặc Claude qua MCP | MCP |
| Switchboard (lập kế hoạch và xây dựng định tuyến cuộc gọi bằng AI) | Switchboard |
Cùng một khóa API cung cấp năng lượng cho REST, các SDK và máy chủ MCP. Dán khóa vào một client MCP với điểm cuối được hiển thị dưới mục Kết nối với ChatGPT & Claude trên màn hình API Nhà phát triển.
Khắc phục sự cố
- "Không thể tạo khóa API" — bạn cần phải là quản trị viên hoặc chủ sở hữu của không gian làm việc. Yêu cầu chủ sở hữu thăng cấp cho bạn, hoặc nhờ họ tạo khóa.
- Mất bí mật — bạn không thể khôi phục nó. Thu hồi khóa trong Cài đặt → API Nhà phát triển và tạo một khóa mới.
- 401 / không được ủy quyền từ mã của bạn — kiểm tra xem khóa là Live hay Test như bạn đã định, rằng nó chưa bị thu hồi, và rằng tiêu đề
Authorization: Bearer …sử dụng toàn bộ bí mật (bao gồm tiền tốody_live_hoặcody_test_). - 403 thiếu phạm vi — khóa được tạo với một tập hợp phạm vi bị thu hẹp. Tạo một khóa mới với các phạm vi mà điểm cuối của bạn cần, hoặc xem Phạm vi.
- Muốn sử dụng Zapier / Make thay vì mã — nhiều công cụ không mã gọi REST API bằng cùng một khóa; xem tổng quan API. Các kết nối CRM và helpdesk tích hợp sẵn nằm trong Ody hỗ trợ những tích hợp nào?.
Bài viết liên quan
Các câu hỏi thường gặp
Tài liệu dành cho nhà phát triển ở đâu?
Mọi thứ dành cho nhà phát triển đều có tại https://dev.ody.co — REST API, webhooks, MCP, Switchboard, và các SDK TypeScript và Python. Trung tâm trợ giúp này chỉ đề cập đến việc tạo khóa API của bạn trong ứng dụng.
Làm cách nào để cài đặt Ody SDK?
TypeScript/JavaScript: npm install @ody-co/sdk. Python: pip install ody-sdk (import as ody). Cả hai đều ở phiên bản v0.6.0, không có phụ thuộc, và bao gồm xác minh webhook.
Ai có thể tạo khóa API?
Quản trị viên không gian làm việc hoặc chủ sở hữu. Mở **Cài đặt → API Nhà phát triển** (trên điện thoại: **Thêm → Cài đặt → API Nhà phát triển**).
Sự khác biệt giữa khóa Live và Test là gì?
Khóa Live (ody_live_…) gửi tin nhắn thực và thực hiện cuộc gọi thực. Khóa Test (ody_test_…) đọc và ghi dữ liệu không gian làm việc thực nhưng không bao giờ gửi tin nhắn thực — các lần gửi được ghi lại dưới dạng mô phỏng. Sử dụng Test trong khi bạn xây dựng.