Tổng quan Developer API
Developer API là gì
Cognivo Developer API cho phép bạn gọi chính lớp trí tuệ on-chain đang vận hành Cognivo Chat, dApp và bot Telegram, ngay từ mã của bạn. Bạn tạo một dự án, tạo một API key, và gửi yêu cầu qua HTTPS thông thường.
- Khu vực Developers là nơi bạn tạo dự án và quản lý các API key Cognivo của mình.
- Chọn Sign in để mở cổng nhà phát triển. Các key của bạn giữ riêng tư với tài khoản của bạn.
Khi nào dùng
Hãy dùng nó khi bạn muốn có câu trả lời của Cognivo bên trong thứ bạn đang xây dựng thay vì bên trong Cognivo. Các trường hợp phổ biến:
- Một bot cộng đồng nơi ai đó dán một địa chỉ hợp đồng và nhận lại các tín hiệu rủi ro, bối cảnh thanh khoản và khóa, cùng một cách đọc lý do vì sao một token đang giảm.
- Một bảng điều khiển giám sát cho quỹ, cho đội ngũ hoặc cho ví cá voi: mức phơi nhiễm từ các phê duyệt, các chuyển động gần đây, lãi lỗ đã thực hiện theo từng token.
- Một sổ tay nghiên cứu kéo dữ liệu token và ví vào Python hoặc JavaScript để làm một nghiên cứu hoặc một bản mổ xẻ sự cố.
Đây không phải quyền truy cập node hay RPC thô. Bạn luôn gọi các endpoint đã được Cognivo tuyển chọn. Không có giao dịch, khớp lệnh hay công cụ MEV. Kết quả là các tín hiệu trí tuệ, không phải lời khuyên tài chính, và một kết quả sạch không bao giờ có nghĩa là một token an toàn.
Tìm ở đâu
Trong dApp, mở thanh bên, rồi Account, rồi Developers. Liên kết trực tiếp là dapp.cognivolabs.io/en/developers. Bạn cần đăng nhập bằng tài khoản Cognivo thông thường của mình. Khi chưa đăng nhập, trang chỉ hiển thị màn hình giới thiệu, không có dự án hay key nào.
Thẻ ở đầu trang mang ba thứ bạn cần để thực hiện lệnh gọi đầu tiên:
- Base URL:
https://api.cognivolabs.io. Thêm một đường dẫn endpoint vào đó để tạo một yêu cầu. - Auth: gửi API key của bạn trong header
X-API-Keyở mọi yêu cầu. Hãy giữ key trên máy chủ của bạn, không bao giờ để trong mã chạy ở trình duyệt. - Chains: trang hiển thị Ethereum, Base, and BSC live, và More chains coming soon. Một số endpoint hỗ trợ ít chain hơn các endpoint khác, và Tham chiếu endpoint cho biết cụ thể.
Cũng thẻ đó liên kết tới bộ tài liệu này và tới OpenAPI spec đọc được bằng máy, thứ bạn có thể nhập vào Postman, Insomnia hoặc một trình sinh SDK.
Bản thân trang này có bốn tab: Quickstart, Keys, Endpoints và Usage. Endpoints là phần tham chiếu kèm ví dụ có thể sao chép và giá của từng lệnh gọi. Trang không có trình chạy trực tiếp, nên không có gì bạn đọc ở đó tiêu tốn chi phí.
Quyền truy cập, key và chi phí
Live key hoạt động theo mô hình tự phục vụ. Tạo một key là nó dùng được ngay, không cần đơn đăng ký và không có hàng chờ phê duyệt. Cổng nhà phát triển nêu rõ mô hình: một số endpoint miễn phí với bất kỳ key đang hoạt động nào, còn các endpoint khác cần quyền truy cập trả phí hoặc Enterprise và được tính phí cho mỗi lệnh gọi thành công, trừ vào số dư tín dụng Cognivo của bạn.
- Live key (
cogv_live_) thực hiện các lệnh gọi thật. Mỗi lệnh gọi thành công được tính bằng tín dụng Cognivo theo giá công bố cho endpoint đó. Các lệnh gọi thất bại không bao giờ bị tính phí. Việc tính phí cho các lệnh gọi Developer API hiện đang tắt, nên một lệnh gọi thành công không trừ gì và số dư của bạn không thay đổi. - Test key (
cogv_test_) được gắn nhãn Test trong cổng nhà phát triển. Chúng có giới hạn chặt và dành để dùng thử API, không dành cho lưu lượng thật. - Mỗi key hiển thị access mode của nó ở tab Keys, chẳng hạn Paid, Trial, Partner, Sandbox, Enterprise hoặc Request access. Một key ở trạng thái Request access phải được phê duyệt trước khi có thể chạy các endpoint trả phí, và một key bị Suspended thì không gọi được gì cả. Cổng nhà phát triển hiển thị lý do.
- Enterprise là con đường duy nhất mà bạn phải yêu cầu quyền truy cập, dành cho mức giá và giới hạn tùy chỉnh. Nút Enterprise access mở luồng hỗ trợ.
Tín dụng đến từ chính số dư bạn dùng ở mọi nơi khác trong Cognivo, và mỗi tài khoản nhận 5 tín dụng miễn phí mỗi ngày, được đặt lại vào nửa đêm theo giờ UTC. Nếu số dư của bạn không đủ cho một lệnh gọi, bạn nhận lỗi 402 với mã payment_required, và không có gì bị tính phí. Hãy nạp thêm rồi thử lại. Xem Thanh toán và tín dụng để biết số dư hoạt động ra sao.
GET /v1/api/health miễn phí và không cần key. GET /v1/api/me miễn phí với bất kỳ key hợp lệ nào. GET /v1/api/discover miễn phí với một hạn mức ngày rất chặt. Giá theo từng endpoint nằm ở Tham chiếu endpoint và Giới hạn tốc độ, lỗi và tính phí.
Bạn nhận lại gì, và một câu trả lời trống nghĩa là gì
Các phản hồi chỉ mang trí tuệ on-chain công khai. Chúng không bao giờ bao gồm định danh tài khoản Cognivo, email, số dư hay dữ liệu tài khoản riêng tư khác, của bạn hay của bất kỳ ai. Ngoại lệ duy nhất là GET /v1/api/me, trả về số dư tín dụng của chính key đang gọi để bạn theo dõi mức chi của mình.
Một trường trống hoặc một giá trị không xác định nghĩa là Cognivo không xác minh được mục đó cho token hoặc ví này trên chain này. Nó không có nghĩa là mục đó không tồn tại, và cũng không có nghĩa là đối tượng đó sạch. Hãy xem một kết quả thiếu là chưa được xác minh, và dùng request ID trong phản hồi nếu bạn cần theo dõi tiếp.
Bước tiếp theo
- Đăng nhập và tạo một dự án, rồi tạo một live key. Key đầy đủ chỉ được hiển thị một lần, nên hãy sao chép ngay lập tức.
- Chạy lệnh gọi đầu tiên của bạn với Khởi động nhanh.
- Đọc Xác thực và API key để biết về quyền, xoay vòng key và an toàn key.