Developer Center là nơi bạn kết nối Exayard với mã và công cụ của riêng mình. Mở nó từ Settings rồi Developer. Từ đây bạn tạo các khóa API, đăng ký các endpoint webhook, và xem lại nhật ký trực tiếp của mọi yêu cầu API. Chỉ quản trị viên tổ chức mới có thể truy cập trang này.
Khóa API
Một khóa API xác thực các yêu cầu đến API của Exayard. Các khóa thuộc về tổ chức của bạn, nên tài khoản đúng được chọn tự động và không cần truyền ID tổ chức.
Mở tab API keys trong thẻ Credentials và nhấp nút +. Đặt cho khóa một Tên, rồi chọn Phạm vi của nó. Chọn All để cấp mọi phạm vi, hoặc Specific để chọn từng quyền riêng lẻ. Các phạm vi tuân theo phân chia đọc và ghi cho mỗi tài nguyên, như read:projects và write:estimates. Phạm vi admin:org là một quyền cấp truy cập đầy đủ. Hãy chọn phạm vi tối thiểu mà tích hợp của bạn cần.
Exayard hiển thị khóa đầy đủ một lần, ngay sau khi bạn tạo nó. Hãy sao chép ngay lúc đó, vì nó không bao giờ được hiển thị lại. Sau đó, mỗi khóa xuất hiện với tên của nó, một bản xem trước được che như ak_••••1234, và ngày nó được sử dụng lần cuối.
Dùng biểu tượng bút chì để đổi tên một khóa hoặc thay đổi phạm vi của nó. Dùng biểu tượng thùng rác để Thu hồi nó. Việc thu hồi là vĩnh viễn và bất kỳ tích hợp nào dùng khóa đó sẽ ngừng hoạt động ngay lập tức.
Cùng một khóa xác thực cho các tích hợp không cần mã. Xem Kết nối Exayard với Zapier, Kết nối Exayard với Make, và Kết nối Exayard với n8n. Để truy cập cho tác nhân và trình soạn thảo AI, xem Kết nối với Claude và các công cụ AI khác.
Webhook
Một webhook yêu cầu Exayard thông báo cho máy chủ của bạn khi có điều gì đó xảy ra. Mở tab Webhooks và nhấp + để thêm một endpoint. Nhập URL sẽ nhận các lần gửi và một Mô tả tùy chọn.
Chọn các Sự kiện để đăng ký. Chọn All để nhận mọi sự kiện, hoặc Specific để chọn từ danh sách:
Sự kiện | Kích hoạt khi |
| Một dự án được tạo |
| Một dự án được thay đổi |
| Một dự án được lưu trữ |
| Một đánh giá bóc tách bắt đầu |
| Một đánh giá hoàn tất |
| Một đánh giá được phê duyệt |
| Một đánh giá bị hủy |
| Một bản dự toán được tạo |
| Một hồ sơ thầu được tạo |
| Một tệp đã tải lên hoàn tất xử lý |
Khi bạn tạo một endpoint, Exayard hiển thị một khóa bí mật ký một lần. Hãy sao chép ngay lúc đó, vì nó không được hiển thị lại.
Bảo mật các lần gửi webhook
Mỗi lần gửi mang theo một header Exayard-Signature ở dạng t=<unix>,v1=<digest>. Exayard xây dựng chữ ký bằng cách ghép dấu thời gian và phần thân yêu cầu, rồi ký chúng bằng HMAC-SHA256 sử dụng khóa bí mật endpoint của bạn.
Để xác minh một lần gửi, hãy tính lại chữ ký bằng khóa bí mật của bạn, xác nhận dấu thời gian nằm trong vòng năm phút so với hiện tại, và so sánh các digest. Các lần gửi thất bại sẽ thử lại theo cơ chế lùi lại theo cấp số nhân trong khoảng ba ngày.
Để chỉnh sửa một endpoint, hãy nhấp biểu tượng bút chì. Bạn có thể thay đổi URL, mô tả và các sự kiện, và đặt Trạng thái của nó thành Active hoặc Paused. Các endpoint bị tạm dừng sẽ ngừng nhận các lần gửi. Cùng hộp thoại đó có một nút Rotate secret. Việc xoay vòng sẽ phát hành một khóa bí mật mới và khóa cũ ngừng hoạt động ngay lập tức, nên hãy cập nhật máy chủ của bạn trước khi xoay vòng. Biểu tượng thùng rác xóa một endpoint và chấm dứt mọi lần gửi đến nó.
Bắt đầu nhanh
Thẻ Quick start chứa một prompt làm sẵn cho một trình soạn thảo AI như Claude hoặc Cursor. Nhấp Copy prompt và dán nó vào trình soạn thảo của bạn. Prompt bao gồm URL cơ sở của API, định dạng xác thực, từ vựng phạm vi, và lược đồ ký webhook, để AI có thể dựng khung một tích hợp hoạt động và hỏi bạn các chi tiết nó cần.
Tài liệu
Thẻ Documentation liên kết đến tài liệu nhà phát triển đầy đủ và OpenAPI spec, vốn mô tả mọi route và lược đồ. Connect MCP mở quy trình thiết lập để kết nối các tác nhân AI trực tiếp với Exayard.
Nhật ký
Mục Logs ghi lại các yêu cầu API gần đây nhất của bạn trên cả REST API và MCP. Mỗi hàng hiển thị phương thức, đường dẫn, trạng thái phản hồi và độ trễ. Chọn một hàng để xem chi tiết đầy đủ của nó, bao gồm ID yêu cầu cùng phần thân yêu cầu và phản hồi. Dùng nhật ký để xác nhận một lệnh gọi đã hoạt động hoặc để gỡ lỗi một tích hợp đang gặp sự cố.
