Các khóa API và API

Một khóa API là một mật khẩu thuộc về một chương trình thay vì một người. Đối xử với nó theo cách tương tự: cấp một khóa cho mỗi hệ thống và thay thế nó khi hệ thống đó thay đổi.

Tạo một khóa

1. Mở API → Quản lý API và nhấn Khóa mới.
2. Đặt tên cho nó để chỉ ra hệ thống nào sử dụng nó.
3. Chọn Quyền truy cập: Truy cập đầy đủ, hoặc chỉ những khu vực mà hệ thống cần. Hầu hết các khu vực phân biệt việc đọc, tạo và thay đổi.
4. Chọn một ngày hết hạn, hoặc không có.
5. Sử dụng Hiển thị và Sao chép trên thẻ khóa để giao khóa cho hệ thống gọi. Hệ thống gửi nó trong authtoken tiêu đề.

Mỗi thẻ khóa hiển thị quyền, ngày tạo, Sử dụng lần cuối và một huy hiệu như “hoạt động” hoặc “hết hạn trong 5 ngày”.

Gia hạn khóa trước khi hết hạn

Mười bốn ngày trước khi một khóa hết hạn, bạn nhận được một thông báo trong chuông. Nhấn Gia hạn trên thẻ khóa và chọn ngày hết hạn mới. IDup tạo một khóa mới với cùng quyền. Sao chép nó ngay lập tức, vì màn hình này chỉ xuất hiện một lần. Khóa cũ vẫn có hiệu lực cho đến khi hết hạn của nó, vì vậy bạn có thể chuyển hệ thống mà không bị gián đoạn.

Các khu vực bạn có thể tiếp cận

API bao gồm dữ liệu khách hàng của bạn và, tùy thuộc vào gói của bạn, tài sản và cho thuê, hồ sơ tìm kiếm, tệp thuế, tệp ủy thác, kế toán, chạy bảng lương và quét biên lai. AI Studio và hộp thư đến có các khu vực riêng của chúng. Hướng dẫn API chỉ liệt kê các khu vực mà gói của bạn bao gồm.

Hướng dẫn API

Mở Tài liệu hướng dẫn tab trên trang quản lý API, hoặc API → Hướng dẫn API. Mỗi khu vực hiển thị các trường của nó, ví dụ yêu cầu mà bạn có thể sao chép, câu trả lời mẫu và mã lỗi.

Webhooks và các giao diện khác

• Các Webhooks tab gửi sự kiện đến hệ thống của bạn khi chúng xảy ra — xem Gửi sự kiện đến hệ thống của bạn với webhooks.
• Nếu API Khách hàng được bật, một Cài đặt API Khách hàng tab mở cài đặt của nó, ví dụ như liệu khách hàng có thể đăng ký thông qua API hay không.
• Tự động hóa / Quy trình làm việc → Giao diện kỹ thuật phát hành một mã thông báo cho giao diện GraphQL.
• AI Studio → Khóa API cá nhân là một bộ khóa riêng biệt.

Giữ an toàn

1. Một khóa cho mỗi hệ thống, không bao giờ dùng chung.
2. Chỉ cấp cho một khóa các quyền mà hệ thống cần.
3. Thiết lập ngày hết hạn và gia hạn theo lịch trình.
4. Xóa một khóa ngay khi ai đó biết nó rời đi, hoặc hệ thống bị tắt.