Tick Up Developers

Khoá API

Khoá API chỉ đọc cho phép công cụ của bạn đọc dữ liệu tuyển dụng qua Data API — không cần tài khoản đăng nhập, không phụ thuộc phiên đăng nhập của ai.

Tạo khoá

Admin công ty vào Cài đặt → Tích hợp → API & dữ liệu.
Bấm Tạo khoá, đặt tên theo công cụ sẽ dùng và chọn hạn dùng (30 ngày, 90 ngày, 1 năm hoặc không hết hạn).
Khoá dạng tk_live_… hiện đúng một lần. Sao chép ngay vào biến môi trường hoặc trình quản lý mật khẩu — đóng hộp thoại là không xem lại được.

Dùng khoá

Gửi khoá trong header Authorization: Bearer tới Data API (xem Data API). Khoá trong URL bị từ chối với lỗi api_key_in_url.

# Never commit this file.
TICKUP_API_KEY=tk_live_…

Phạm vi, giới hạn và thu hồi

Chỉ đọc, toàn công ty. Khoá thuộc về công ty, không thuộc người tạo — người tạo rời công ty thì khoá vẫn chạy cho tới khi bị thu hồi hoặc hết hạn.
Tối đa 5 khoá đang dùng mỗi công ty. Mỗi công cụ một khoá để thu hồi riêng được.
Thu hồi có hiệu lực ngay và luôn làm được, kể cả khi gói dịch vụ đã hết hạn.
Khoá hết hạn hoặc đã thu hồi trả lỗi 401 invalid_api_key. Trang Cài đặt hiện lần dùng cuối của từng khoá.

Quản lý khoá qua API

Ba route dưới đây dành cho admin đã đăng nhập (token phiên Authorization: Bearer của tài khoản admin) — màn Cài đặt dùng chính chúng. Bản thân khoá API không quản lý được khoá.

POST/api/v1/api-keysCần xác thực

Tạo khoá. Phản hồi có trường key đầy đủ — lần duy nhất. Vượt 5 khoá trả 422 api_key_limit.

Body

Trường	Kiểu	Mô tả
`name`bắt buộc	`string`	Tên khoá, 1–100 ký tự.
`expires_in_days`	`30 \| 90 \| 365 \| null`	Số ngày hiệu lực; null = không hết hạn; bỏ trống = 365.

GET/api/v1/api-keysCần xác thực

Danh sách khoá của công ty (không bao giờ có khoá đầy đủ): tiền tố, người tạo, lần dùng cuối, hạn, trạng thái.

DELETE/api/v1/api-keys/{key_id}Cần xác thực

Thu hồi khoá ngay lập tức. Gọi lại với khoá đã thu hồi không lỗi.

Khác gì token đăng nhập

Token đăng nhập (Xác thực) đại diện cho một người, hết hạn sau 24 giờ và mở toàn bộ API theo quyền của người đó. Khoá API đại diện cho công ty, sống tới khi hết hạn/thu hồi và chỉ mở Data API ở chế độ chỉ đọc (data:read).