API token
Tạo token cho Local API, giới hạn quyền của nó, và thu hồi khi cần.
Token dùng để làm gì
API token dùng để xác thực chương trình bạn tự viết với Local API của ứng dụng desktop — giao diện HTTP mà ứng dụng mở ngay trên máy bạn để chạy profile, đọc trạng thái và điều khiển chúng. Đây là cách bạn xây công cụ riêng dựa trên ứng dụng.
Token dùng cho Local API trên máy bạn. Không có REST API công khai trên cloud: website và ứng dụng desktop nói chuyện với server qua phiên đăng nhập riêng của chúng, và đó không phải là một bề mặt tích hợp được công bố.
Tạo token
- Mở Cài đặt, vào tab Local API, rồi chọn API Token.
- Đặt tên theo đúng thứ sẽ dùng nó, để sau này nhìn lại còn truy ra được là của chương trình nào.
- Chỉ tích những quyền mà chương trình đó thực sự cần.
- Đặt ngày hết hạn nếu muốn.
- Sao chép token. Nó bắt đầu bằng sk_ và chỉ hiện một lần duy nhất — server chỉ lưu bản băm và không thể hiện lại cho bạn.
Gửi kèm trong header X-Token
curl http://127.0.0.1:PORT/profiles \
-H "X-Token: sk_your_api_token_here"
Phân quyền
Quyền được cấp theo từng nhóm, mỗi nhóm có ba công tắc riêng là đọc, ghi và xoá:
- Profile — đọc danh sách profile, tạo và sửa profile, xoá profile.
- Thư mục — các nhóm dùng để sắp xếp profile.
- Proxy — đọc, thêm và gỡ proxy.
- Team — dữ liệu team.
Chỉ cấp quyền xoá khi chương trình thật sự có xoá. Một token chỉ-đọc bị lộ là vấn đề về thông tin; một token có quyền xoá bị lộ là vấn đề về khôi phục dữ liệu.
Đổi và thu hồi
- Tạo lại — cấp một chuỗi bí mật mới cho cùng token đó và vô hiệu ngay chuỗi cũ. Dùng khi nghi token đã bị lộ.
- Xoá — gỡ hẳn token. Chương trình nào còn dùng nó sẽ hỏng ngay lập tức.
- Hết hạn — token quá ngày hết hạn sẽ bị từ chối, nên token cấp cho một việc ngắn hạn không sống lâu hơn việc đó.