Xác thực
Mọi yêu cầu gửi đến API đều mang theo khóa API. Yêu cầu không bao giờ được đối chiếu với phiên trình duyệt.
Tạo khóa API
Tạo khóa tại Khóa API trong tài khoản của bạn, tối đa 5 khóa. Bạn có thể sao chép khóa API từ trang đó bất cứ lúc nào khi đã đăng nhập: chúng tôi lưu khóa ở dạng mã hóa và chỉ hiển thị cho bạn. Hãy giữ bí mật khóa như mật khẩu, và nếu khóa có thể đã bị người khác nhìn thấy, hãy thu hồi rồi tạo khóa mới.
Gửi khóa API
Gửi trong header Authorization dưới dạng Bearer theo sau là khóa. X-API-Key cũng dùng được.
curl "https://api.talismanleads.io/v1/account" \
-H "Authorization: Bearer tl_live_your_key_here"Khóa API có thể làm gì
Khóa API mới có thể làm mọi thứ: xem số dư, các trình kiểm tra, đơn hàng và kết quả của bạn, và dùng POST /uploads, POST /estimates và POST /orders, những lệnh lưu danh sách của bạn hoặc tiêu số dư của bạn. Khóa được tạo trước ngày 8 tháng 11 năm 2026 có thể chỉ đọc: khóa xem được mọi thứ, nhưng ba lệnh gọi đó sẽ từ chối khóa với missing_scope.
Thời hạn và địa chỉ IP
Khóa API mới không bao giờ hết hạn và hoạt động từ mọi địa chỉ. Khóa được tạo trước ngày 8 tháng 11 năm 2026 có thể có ngày hết hạn, sau đó khóa bị từ chối với expired_key, hoặc bị giới hạn ở các địa chỉ IP của máy chủ của bạn, khiến yêu cầu từ bất kỳ nơi nào khác bị từ chối với ip_not_allowed. Để thay đổi một trong hai điều này, hãy tạo khóa mới và thu hồi khóa cũ.
Giữ an toàn cho khóa API
- Hãy xem khóa API như mật khẩu: bất kỳ ai giữ khóa đều có thể tiêu số dư của bạn.
- Chỉ dùng trên máy chủ của bạn. API không cho phép gọi từ trang web.
- Đừng để khóa trong mã nguồn và hệ thống quản lý phiên bản của bạn.
- Nếu khóa API có thể đã bị người khác nhìn thấy, hãy thu hồi ngay trong tài khoản của bạn. Khóa ngừng hoạt động ngay lập tức. Các đơn hàng đã đặt vẫn tiếp tục chạy.
- Chỉ gửi khóa đến API. Liên kết tải lên và tải xuống mang quyền riêng của chúng, vì vậy đừng gửi khóa API của bạn đến các liên kết đó.
Khi khóa API bị từ chối
Khóa API sai, đã thu hồi hoặc đã hết hạn sẽ nhận phản hồi 401. Khóa API hoặc tài khoản đã bị chặn sẽ nhận phản hồi 403. Xem Lỗi.