Khóa và bí mật
Lưu thông tin xác thực riêng tư của app trong Atoms Cloud → Khóa để giữ giá trị của chúng không xuất hiện trong Chat và mã nguồn, đồng thời quản lý riêng các giá trị Test và Production.
Lưu thông tin xác thực riêng tư của app trong Atoms Cloud → Khóa để giữ giá trị của chúng không xuất hiện trong Chat và mã nguồn, đồng thời quản lý riêng các giá trị Test và Production.
Trước khi sử dụng Khóa, hãy kết nối dự án với Atoms Cloud. Nếu chưa được kết nối, hãy yêu cầu Agent kết nối Atoms Cloud hoặc làm theo Atoms Cloud.
Sử dụng một khóa trong Atoms Cloud
Trước khi bắt đầu
Trước khi thêm khóa, hãy đảm bảo:
- Bạn đang sử dụng Atoms trên web máy tính.
- Dự án đã được kết nối với Atoms Cloud.
- Bạn là chủ sở hữu không gian làm việc. Chỉ chủ sở hữu không gian làm việc mới có thể thêm khóa mới.
Nếu Khóa hoặc Khóa mới không khả dụng, hãy xác nhận rằng bạn đã mở đúng dự án và dự án đó đã được kết nối với Atoms Cloud. Nếu Khóa mới vẫn không khả dụng, hãy xác nhận rằng bạn là chủ sở hữu không gian làm việc. Nếu Atoms hiển thị thông báo về gói hoặc khả năng sử dụng, hãy làm theo hướng dẫn khả dụng hoặc lộ trình nâng cấp trên màn hình, rồi thử lại.
Thêm khóa Test
- Mở dự án trên thiết bị máy tính.
- Trong cùng thanh công cụ không gian làm việc nơi có Trình xem App , hãy chọn Atoms Cloud.
- Chọn Khóa trong thanh bên Atoms Cloud.
- Mở Khóa Test, sau đó chọn Trong dự án này.
- Chọn Khóa mới.
- Hoàn thành các trường bắt buộc:
- Tên: Nhập tên tham chiếu rõ ràng, chẳng hạn như RESEND_API_KEY. Sử dụng chữ cái, số và dấu gạch dưới, đồng thời bắt đầu bằng chữ cái hoặc dấu gạch dưới.
- Giá trị: Nhập thông tin xác thực chính xác như nhà cung cấp cung cấp.
- Mô tả: Giải thích khóa này dùng để làm gì, chẳng hạn như Dùng để gửi email tài khoản. Không bao gồm giá trị thông tin xác thực.
- Nếu bạn muốn dùng lại khóa trong các dự án khác, hãy chọn Lưu vào Thư viện.
- Chọn Thêm. Khi khóa đã được lưu, Atoms sẽ hiển thị Đã thêm khóa thành công.
Thêm khóa Test
Chỉ chủ sở hữu không gian làm việc mới có thể thêm khóa mới. Nếu bạn cần thêm khóa, hãy yêu cầu chủ sở hữu không gian làm việc.
Sử dụng khóa đã lưu trong Chat
Tham chiếu khóa đã lưu thay vì nhập giá trị của khóa trong tin nhắn.
- Mở Chat của dự án trong phiên bản Atoms trên máy tính và nhập
#. - Chọn Khóa.
- Tìm khóa đã lưu, sau đó chọn tên của khóa.
- Cho Agent biết khóa này dùng để làm gì và bạn muốn tích hợp thực hiện điều gì.
Menu # thêm một tham chiếu đến khóa đã lưu mà không chèn giá trị của khóa vào tin nhắn của bạn.
Tham chiếu khóa đã lưu trong Chat
Kiểm tra khóa đã lưu
- Trong Trình xem App, thực hiện một thao tác đơn giản có sử dụng khóa.
- Xác nhận rằng thao tác đó tạo ra kết quả mong đợi, chẳng hạn như gửi email thử nghiệm hoặc trả về dữ liệu thử nghiệm.
- Xem lại mọi lỗi hoặc nhật ký hiển thị và đảm bảo chúng không làm lộ giá trị của khóa.
Nếu dịch vụ cung cấp cho bạn khóa test và khóa live riêng biệt, hãy dùng khóa test trong khi xây dựng app. Chỉ dùng khóa live sau khi app của bạn được xuất bản. Nếu việc kiểm tra thất bại, hãy kiểm tra bảng điều khiển của nhà cung cấp để xác nhận rằng khóa đang hoạt động và có quyền thực hiện hành động được yêu cầu. Không bao giờ dán giá trị của khóa vào Chat khi khắc phục sự cố.
Hiểu cách Khóa hoạt động
Trước khi thêm khóa, sẽ hữu ích nếu bạn hiểu Atoms lưu trữ gì và cách bảo vệ thông tin xác thực của mình.
Atoms lưu trữ gì
Atoms Cloud → Khóa lưu trữ thông tin xác thực mà app của bạn dùng để kết nối với các dịch vụ bên ngoài, chẳng hạn như khóa API và token truy cập.
Mỗi khóa đã lưu có tên, mô tả và giá trị riêng tư. Tên và mô tả giúp Agent hiểu khi nào nên sử dụng khóa, trong khi giá trị riêng tư vẫn được ẩn khỏi Chat.
Lấy khóa ở đâu
Atoms không tạo hoặc cung cấp thông tin xác thực cho các dịch vụ bên ngoài. Bạn phải lấy chúng từ nhà cung cấp dịch vụ liên quan. Hãy làm theo hướng dẫn của nhà cung cấp khi chọn quyền, kiểm tra khóa và kiểm tra xem khóa có hết hạn hay không.
Giữ bí mật thông tin xác thực riêng tư
Không bao giờ dán thông tin xác thực riêng tư vào Chat, mã nguồn, mã chạy trong trình duyệt, ảnh chụp màn hình, nhật ký hoặc tin nhắn hỗ trợ. Hãy lưu nó trong Khóa, sau đó tham chiếu mục đã lưu theo tên.
Nếu một giá trị riêng tư đã bị lộ, hãy coi nó là đã bị xâm phạm và thu hồi hoặc xoay vòng nó thông qua nhà cung cấp.
Thông tin xác thực riêng tư và an toàn cho trình duyệt
Khóa không gắn nhãn các giá trị đã lưu là Công khai hoặc Riêng tư. Việc lưu một giá trị trong Khóa không tự động làm cho giá trị đó an toàn để sử dụng trong mã hướng tới trình duyệt. Nếu app của bạn sử dụng giá trị đó trong trình duyệt, khách truy cập có thể kiểm tra được nó.
Hãy kiểm tra tài liệu của nhà cung cấp trước khi quyết định sử dụng thông tin xác thực ở đâu:
- Chỉ sử dụng một giá trị trong mã hướng tới trình duyệt khi nhà cung cấp nêu rõ rằng việc để lộ giá trị đó là an toàn.
- Giữ thông tin xác thực riêng tư trong logic phía máy chủ hoặc backend, nơi chúng không bị lộ cho khách truy cập app.
Chọn môi trường và nơi lưu trữ của khóa
Khi thêm khóa, bạn cần đưa ra hai quyết định riêng biệt:
- Môi trường nào sẽ sử dụng khóa.
- Liệu khóa sẽ chỉ nằm trong dự án này hay có sẵn cho các dự án khác.
Chọn một môi trường
Tùy chọn | Khi nào được sử dụng |
|---|---|
Khóa Test | Được dùng trong khi phát triển và kiểm tra app của bạn trong Trình xem App. Nếu bạn không thêm một giá trị Production riêng, app đã xuất bản cũng sẽ dùng giá trị Test. |
Khóa Production | Được app đã xuất bản sử dụng khi cần một thông tin xác thực live riêng biệt. Các giá trị Production được thêm trong quá trình xuất bản và được quản lý tách biệt với các giá trị Test. |
Chọn nơi lưu khóa
Tùy chọn | Khi nào nên dùng |
|---|---|
Trong dự án này | Chọn tùy chọn này cho khóa chỉ nên được dùng bởi dự án hiện tại. |
Thư viện Khóa | Chọn tùy chọn này khi bạn chủ ý muốn dùng lại một khóa trên nhiều dự án. Khi thêm hoặc cập nhật khóa Test, hãy chọn Lưu vào Thư viện để làm cho khóa đó khả dụng trong thư viện. |
Môi trường và vị trí lưu trữ là độc lập với nhau. Việc lưu khóa Test vào Thư viện Khóa khiến khóa đó có thể được dùng lại, nhưng không biến nó thành giá trị Production.
Mặc định hãy dùng Trong dự án này. Chỉ lưu khóa vào thư viện khi bạn chắc chắn rằng khóa đó nên được chia sẻ giữa các dự án.
Sử dụng một giá trị Production riêng
Khi bạn xuất bản một dự án có sử dụng khóa đã lưu, luồng xuất bản có thể yêu cầu bạn cấu hình Khóa Production. Theo mặc định, app đã xuất bản sẽ dùng giá trị Test. Để sử dụng một thông tin xác thực khác, hãy chọn Production và lưu một giá trị riêng cho khóa đó.
Hãy dùng một giá trị Production riêng khi:
- Nhà cung cấp cung cấp thông tin xác thực test và live khác nhau.
- Bạn không muốn thông tin xác thực được dùng trong quá trình phát triển lại được dùng bởi app đã xuất bản.
Các giá trị Production được tạo thông qua luồng xuất bản. Bạn không thể tạo một giá trị bằng cách chọn Khóa mới từ tab Khóa Production. Sau khi một giá trị Production đã được cấu hình cho app đã xuất bản, bạn có thể xem nó trong Atoms Cloud → Khóa → Khóa Production.
Sau khi xuất bản hoặc cập nhật app, hãy lặp lại hành trình người dùng liên quan trên website đã xuất bản để xác nhận rằng khóa Production hoạt động chính xác. Để biết quy trình triển khai đầy đủ, hãy xem Xuất bản và triển khai.
Cập nhật hoặc xoay vòng một thông tin xác thực
Cập nhật một giá trị Test đã lưu
- Mở Atoms Cloud → Khóa → Khóa Test.
- Mở Trong dự án này hoặc Thư viện Khóa, tùy thuộc vào nơi mục đó đã được lưu.
- Chọn Giá trị hoặc Mô tả của khóa, nhập thông tin đã cập nhật, rồi chọn Cập nhật.
- Chờ Lưu thành công, sau đó kiểm tra lại luồng bị ảnh hưởng.
Xoay vòng khóa theo kế hoạch
Hãy làm theo các bước này khi thông tin xác thực hiện có vẫn an toàn và bạn muốn thay thế nó mà không làm gián đoạn app của mình:
- Tạo một thông tin xác thực thay thế thông qua nhà cung cấp dịch vụ.
- Thay thế giá trị Test trong Atoms, sau đó kiểm tra tính năng bị ảnh hưởng trong Trình xem App.
- Nếu app đã xuất bản sử dụng một giá trị Production riêng, hãy thay thế nó và xuất bản bản cập nhật.
- Kiểm tra cùng tính năng đó trên website đã xuất bản.
- Sau khi xác nhận rằng giá trị thay thế hoạt động chính xác, hãy thu hồi thông tin xác thực cũ thông qua nhà cung cấp.
Nếu một thông tin xác thực có thể đã bị lộ
Hãy coi thông tin xác thực đó là đã bị xâm phạm và hành động ngay lập tức:
- Thu hồi hoặc vô hiệu hóa nó thông qua nhà cung cấp dịch vụ.
- Tạo một thông tin xác thực thay thế.
- Cập nhật các giá trị Test và Production liên quan trong Atoms.
- Kiểm tra lại các tính năng bị ảnh hưởng trong cả Trình xem App và app đã xuất bản.
- Xóa mọi bản sao bị lộ khỏi mã nguồn, Chat, ảnh chụp màn hình và nhật ký nếu có thể.
Việc xóa một khóa hoặc xóa giá trị của nó khỏi Atoms không thu hồi thông tin xác thực gốc. Bạn phải thu hồi nó thông qua nhà cung cấp dịch vụ.
Xóa một thông tin xác thực
Trước khi xóa một khóa đã lưu, hãy đảm bảo app của bạn không còn phụ thuộc vào nó:
- Xóa tính năng sử dụng khóa đó hoặc thay thế các tham chiếu của nó bằng một khóa đã lưu khác.
- Thu hồi thông tin xác thực gốc thông qua nhà cung cấp dịch vụ để nó không còn có thể được sử dụng.
- Mở Atoms Cloud → Khóa, tìm mục không hoạt động, chọn Xóa và xác nhận.
Việc xóa một khóa không thể hoàn tác. Nó cũng có thể làm hỏng bản xem trước hoặc các checkpoint cũ hơn vẫn còn tham chiếu đến khóa đó. Nếu Xóa không khả dụng, khóa đó vẫn đang được đánh dấu là hoạt động. Hãy xóa hoặc thay thế mọi tham chiếu đến nó trước khi thử lại.
Câu hỏi thường gặp
Khóa Test của tôi hoạt động trong Trình xem App nhưng không hoạt động sau khi xuất bản. Tại sao?
Nếu khóa Test của bạn hoạt động trong Trình xem App nhưng app đã xuất bản bị lỗi vì thiếu khóa hoặc khóa trống:
- Kiểm tra xem giá trị Test hoặc Production liên quan đã được lưu trước hay sau lần xuất bản gần nhất. Nếu được lưu sau đó, hãy xuất bản lại để thay đổi có hiệu lực.
- Xác minh rằng khóa đã lưu có đúng giá trị Test hoặc Production. App đã xuất bản sử dụng giá trị Test trừ khi một giá trị Production riêng đã được cấu hình.
- Xem lại các lỗi từ dịch vụ downstream để tìm manh mối. “Unauthorized” thường cho thấy khóa trống hoặc không chính xác cho môi trường đó.
Nếu sự cố vẫn tiếp diễn, hãy liên hệ Support và bao gồm:
- Liên kết dự án hoặc URL live
- Tên khóa bị ảnh hưởng và liệu giá trị Test hay Production gặp sự cố
- Toàn bộ lỗi từ dịch vụ downstream
- Ảnh chụp màn hình đã được ẩn thông tin nhạy cảm của trang cấu hình
- Việc cấu hình khóa đã được lưu trước hay sau khi xuất bản
Quan trọng: Chỉ cung cấp tên khóa. KHÔNG gửi giá trị bí mật, mật khẩu hoặc token.