Truy cập API và xác thực

SPREEAI cung cấp tài liệu tham khảo API công khai cho các quy trình làm việc của đối tác đã được phê duyệt: https://docs.spreeai.com/swagger/public/.

Mô hình truy cập

Phạm vi API, môi trường, thông tin xác thực và các thao tác được phép sẽ được thống nhất trong quá trình hợp tác với đối tác. Không nên cho rằng điểm cuối API nội bộ, phát triển hoặc cũ có sẵn trong môi trường sản xuất.

Quy tắc xác thực

• Chỉ lưu trữ thông tin bí mật của khách hàng và mã truy cập trong kho lưu trữ bí mật an toàn phía máy chủ.
• Tuyệt đối không được đưa thông tin đăng nhập vào Git, tài liệu, hệ thống theo dõi lỗi, ảnh chụp màn hình hoặc ứng dụng mẫu.
• Tuyệt đối không gửi thông tin đăng nhập đến các nền tảng phân tích hoặc ghi nhật ký.
• Chỉ sử dụng thông tin xác thực dành riêng cho môi trường đó trong môi trường mà chúng được cấp phép.
• Hãy thay đổi thông tin xác thực ngay lập tức nếu nó bị lộ.
• Xóa bỏ các tiêu đề và mã thông báo xác thực khỏi các yêu cầu hỗ trợ.

Trình duyệt so với máy chủ

Bộ SDK web sử dụng cấu hình trình duyệt do đối tác cung cấp. Không được phép bao gồm mã bí mật máy khách trong trình duyệt.

Việc tích hợp phía máy chủ cần tuân theo quy trình xác thực và định nghĩa điểm cuối trong tài liệu tham khảo API hiện hành đã được phê duyệt. Khi một thao tác cần thiết không có sẵn, hãy yêu cầu thao tác đó thông qua bộ phận Kỹ thuật Đối tác thay vì xây dựng một tuyến đường không được ghi chép lại.

Webhooks

Webhook đẩy từ máy chủ hiện không được đề cập trong tài liệu SDK Web đã công bố. Hãy xác nhận mọi yêu cầu về webhook trước khi thiết kế phụ thuộc vào nó.

Danh sách kiểm tra môi trường

• [ ] Tên môi trường đã được ghi lại.
• [ ] URL cơ sở đến từ tài liệu tham khảo đã được phê duyệt hoặc quá trình chuyển giao trong giai đoạn tiếp nhận.
• [ ] Thông tin xác thực đã được cấp cho môi trường đó.
• [ ] Các thông tin bí mật được lưu trữ ở phía máy chủ.
• [ ] Nhật ký che giấu mã thông báo và hình ảnh khách hàng.
• [ ] Thời gian chờ, thử lại và hành vi bất biến đã được thống nhất cho các thao tác ghi.
• [ ] Một bài kiểm tra phi sản xuất thành công trước khi quyền truy cập sản xuất được sử dụng.