Key và webhook
Các thông tin xác thực và endpoint mà workspace này đã cấp.
Công cụ key và webhook
| Công cụ | Chức năng |
|---|---|
| listApiKeys | Mọi API key workspace này đã cấp, key đó được làm gì và được gửi dưới danh nghĩa địa chỉ nào, hiển thị dưới dạng che bớt vừa đủ để phân biệt hai key với nhau chứ không hơn. |
| rotateApiKey | Cấp cho một key một secret mới, giữ nguyên id, tên, scope, vai trò và phạm vi gửi của nó. Không có khoảng thời gian dùng chồng, và secret mới chỉ hiện ra một lần. |
| setApiKeyEnabled | Tắt một key, hoặc bật lại. Đây là thao tác đảo ngược được: key giữ nguyên secret, scope, vai trò và phạm vi gửi của nó. |
| revokeApiKey | Thu hồi vĩnh viễn một key. Một key đã thu hồi thì không bao giờ bật lại, xoay vòng hay sửa đổi được nữa. |
| setApiKeySendScope | Nêu những địa chỉ mà một key được gửi dưới danh nghĩa, dưới dạng hai danh sách độc lập. Thứ bạn truyền vào sẽ THAY THẾ thứ key đang có. |
| listWebhooks | Mọi endpoint webhook workspace này có, nó gửi tới đâu, có đang bật hay không và nó đã đăng ký những sự kiện nào. Secret dùng để ký thì không bao giờ được hiển thị. |
| listWebhookEvents | Mọi sự kiện mà một endpoint có thể đăng ký, nhóm theo họ sự kiện, kèm một dòng nói rõ khi nào mỗi sự kiện kích hoạt. |
Một secret chỉ hiện ra một lần, lúc key được tạo hoặc xoay vòng, và sau đó không gì lấy lại được. rotateApiKey là công cụ duy nhất ở đây trả về một secret, nên thứ gì đang giữ secret cũ phải được giao bản thay thế trước lần chạy kế tiếp.
Hãy dùng setApiKeyEnabled trước khi dùng revokeApiKey. Tắt một key là việc đảo ngược được và cho bạn biết liệu còn thứ gì phụ thuộc vào nó hay không; thu hồi thì vĩnh viễn và đường đi tiếp duy nhất là một key mới với một secret mới.
Ở đây không có createApiKey và cũng không có createWebhook, vì cùng lý do không có createRole: cấp một thông tin xác thực từ trong một cửa sổ chat là một thay đổi âm thầm, phạm vi rộng mà về sau không ai nhìn thấy. Cả hai đều nằm trong Settings, nơi người thực hiện nhìn được thứ mình đang trao đi.