Skip to main content
API công khai được cung cấp dưới /v1 trên nguồn gốc bảng điều khiển Failproof AI của bạn.

Tạo khóa và thực hiện yêu cầu

  1. Mở Administration → Keys, chọn Create key, và chọn preset quyền hạn nhất có thể bao gồm tích hợp.
  2. Chỉ thêm các cấp phép cá nhân khi cần thiết, tạo khóa, và sao chép bí mật một lần của nó.
  3. Thực hiện yêu cầu kiểm tra đến /v1/sessions và xác nhận khóa vẫn hoạt động trong trang Keys.
  4. Xoay hoặc vô hiệu hóa khóa từ menu hành động của nó khi quyền sở hữu tích hợp thay đổi. Ngăn kéo khóa API mới với preset quyền hạn và cấp phép cá nhân.
Ngăn kéo tạo được hiển thị ở trên. Bí mật một lần chỉ xuất hiện sau khi bạn chọn create; sao chép nó trước khi đóng xác nhận đó.
Các khóa được xác định phạm vi cho một tổ chức và bộ quyền hạn. Yêu cầu không có quyền hạn bắt buộc của điểm cuối trả về 403 và xác định quyền hạn bị thiếu.

Lựa chọn tổ chức

Khóa tổ chức hoạt động trên tổ chức của nó một cách tự động. Khóa có phạm vi instance có thể chọn một tổ chức cho mỗi yêu cầu:
Sử dụng công tắc chuyển đổi tổ chức trong tiêu đề bảng điều khiển trước khi mở Administration → Keys. Các khóa được tạo ở đó thuộc về tổ chức được chọn. Xác nhận slug tổ chức trong URL và chi tiết khóa trước khi sao chép thông tin xác thực vào tự động hóa.
Sử dụng các trang điểm cuối được tạo trong phần này cho các đường dẫn, tham số, yêu cầu quyền hạn và mã trạng thái hiện tại. Thông số kỹ thuật được tạo từ các chú thích tuyến đường máy chủ và được kiểm tra so với bộ định tuyến /v1. Thông số kỹ thuật hiện tại có phạm vi đầy đủ tuyến đường, phương thức, tham số, quyền hạn và mã trạng thái. Một số phần nội dung phản hồi vẫn được để không được nhập vào một cách cố ý vì máy chủ vẫn xây dựng chúng dưới dạng JSON động. Kiểm tra phản hồi thực tế trước khi tạo máy khách được nhập mạnh xung quanh điểm cuối mà không có lược đồ phản hồi. Sử dụng Content-Type: application/json cho ghi JSON. Coi 401 là xác thực bị thiếu hoặc không hợp lệ, 403 là danh tính hợp lệ mà không có quyền hạn bắt buộc, 404 là tài nguyên bị thiếu hoặc không thể truy cập tổ chức, 409 là xung đột trạng thái, và 422 là giá trị trường hoặc quyền hạn không hợp lệ. Phản hồi lỗi bao gồm thông báo có thể đọc được của con người; các lỗi quyền hạn cũng đặt tên cho cấp phép bắt buộc.
Triển khai thực thi chính sách được quản lý cố ý bên ngoài bề mặt /v1 công khai thông thường. Sử dụng quy trình triển khai Cloud được hỗ trợ.