Public API

API quản lý máy chủ-to-máy chủ cho tài khoản Submeto của bạn.

Có sẵn cho mọi người dùng Submeto đang hoạt động, kể cả gói Free. Quyền truy cập Public API mặc định bị tắt và phải được bật trong Dashboard sau khi xem xét các rủi ro bảo mật.

Dành cho máy chủ, không phải trình duyệt

Public API dành cho các quy trình tự động chạy trên hạ tầng bạn kiểm soát — cron job, backend, pipeline CI. API quản lý Biểu mẫu và Trường, đồng thời đọc và xử lý Nội dung gửi. API này tách biệt với Form Submission API, vốn nhận dữ liệu biểu mẫu từ khách truy cập website; nếu đó là nhu cầu của bạn, hãy bắt đầu với tài liệu Form Submission API.

Bạn có thể làm gì

Mỗi thao tác được cấp quyền bởi các scope trên API Key và những Biểu mẫu được cấp cho key đó.

  • Quản lý Biểu mẫu — liệt kê, tạo, cập nhật và xóa biểu mẫu, chịu sự điều khiển của các scope forms:read, forms:create, forms:update và forms:delete.
  • Định nghĩa Trường — đọc và cập nhật cấu hình trường của biểu mẫu với scope forms:read và forms:update.
  • Đọc Nội dung gửi — liệt kê nội dung gửi theo biểu mẫu và đánh dấu đã đọc với scope submissions:read và submissions:mark_read.
  • Truy cập Tệp — nhận quyền tải xuống ngắn hạn, được cấp phép cho các tệp đính kèm nội dung gửi.
  • Vận hành Workflow — kiểm tra và chỉnh sửa bản nháp, xác thực và xuất bản phiên bản, chạy kiểm thử khô, xem các lần chạy và thử lại lỗi đủ điều kiện.

Ranh giới bảo mật

  • API Key xác thực máy chủ của bạn, không phải trình duyệt hay ứng dụng mobile. Chỉ sử dụng runtime máy chủ-to-máy chủ qua HTTPS.
  • Key mang các scope đã chọn và chỉ có thể được cấp cho những Biểu mẫu được chọn. Resource chưa được cấp sẽ không hiển thị với Key.
  • Phản hồi không bao gồm secret, token Biểu mẫu, cấu hình tích hợp hoặc payload gửi thô.
  • Các thao tác phá hủy cần xác nhận ở cấp ứng dụng bên cạnh các scope.