Key thuộc project
API key dùng để kết nối phần mềm hoặc AI với project. Key không phải mật khẩu đăng nhập và không tự có mọi quyền. Khi tạo key, kiểm tra đúng project và chọn scopes theo nhiệm vụ.
Chọn scope
| Nhu cầu | Scope |
|---|---|
| Gửi render, xem status và tải PDF qua render API | template:render |
| Đọc bằng project MCP | mcp:read |
| Chỉnh bằng project MCP | mcp:read và mcp:write |
Key render không mặc định dùng được mọi API quản lý workspace/template. Nhiều thao tác web app dùng phiên đăng nhập thay vì key này.
Tạo và lưu key
- Mở API Keys trong project, tạo key và chọn quyền.
- Copy secret ngay khi được hiển thị; không trông chờ có thể xem lại nguyên secret.
- Lưu trong secret manager hoặc biến môi trường của backend/client MCP phù hợp.
- Thử một thao tác đúng quyền để kiểm tra kết nối.
Không nhúng key vào website công khai hoặc commit vào Git. Với ví dụ API, dùng header ApiKey:
ApiKey: <YOUR_API_KEY>Rotate và revoke
Rotate khi cần thay credential và cập nhật bên đang sử dụng. Revoke khi không dùng hoặc nghi ngờ lộ key. Kiểm tra lại integration sau thay đổi; không gửi credential cũ trong báo lỗi.
Lỗi thường gặp
401: kiểm tra key/header và quyền cần thiết. 403 hoặc sai project: kiểm tra template có thuộc project của key không. Không tăng tất cả scopes chỉ để bỏ qua một lỗi mà chưa hiểu nguyên nhân.