Tim Kencang.in
API Kencang.in cho phép ứng dụng của bạn tạo, đọc, thay đổi và xóa các liên kết ngắn, mã QR và trang bio mà không cần mở bảng điều khiển. Bài viết này là điểm khởi đầu: cách lấy khóa, định dạng yêu cầu và ví dụ đầu tiên có thể chạy trong năm phút. Tài liệu đầy đủ cho từng điểm cuối có sẵn tại trang dành cho nhà phát triển.
1. Lấy khóa API
Vào bảng điều khiển, mở menu Nhà phát triển (hoặc Cài đặt > API). Mỗi tài khoản có một khóa chính và bạn có thể tạo các khóa bổ sung với các tên khác nhau cho từng ứng dụng, do đó, các khóa bị rò rỉ có thể bị thu hồi mà không làm gián đoạn quá trình tích hợp khác. Quyền truy cập API có sẵn trên các gói Pro và Business; xem giới hạn trên trang bảng giá.
2. Xác thực
Tất cả yêu cầu phải bao gồm tiêu đề Authorization: Bearer YOUR_API_KEY. Cơ chế Bearer tuân theo RFC 6750. Các yêu cầu không có khóa hoặc có khóa bị thu hồi sẽ nhận được phản hồi HTTP 401. Luôn gửi yêu cầu qua HTTPS; các khóa được gửi qua HTTP thường được coi là bị rò rỉ.
3. Định dạng yêu cầu và phản hồi
API chấp nhận và trả về JSON. Bao gồm tiêu đề Content-Type: application/json cho yêu cầu POST và PUT. Mỗi phản hồi có khóa error: giá trị 0 có nghĩa là thành công, nếu không sẽ đi kèm message giải thích vấn đề. Kiểm tra phím này trước khi đọc dữ liệu khác. Định dạng JSON tuân theo các thông số kỹ thuật trong json.org.
4. Yêu cầu đầu tiên: tạo một liên kết ngắn
Các tham số phổ biến được sử dụng trong các điểm cuối tạo liên kết:
url(bắt buộc): URL đích, phải bắt đầu bằng http:// hoặc https://.custom: bí danh tùy chỉnh. Nếu trống, một bí danh ngẫu nhiên sẽ được tạo.domain: tên miền có thương hiệu đã được xác minh trên tài khoản của bạn.password: bảo vệ bằng mật khẩu.expiry: ngày hết hạn ở định dạng YYYY-MM-DD.type: loại chuyển hướng, ví dụ:directhoặcsplashcho các trang đích tùy chỉnh.metatitle,metadescription: xem trước tiêu đề và mô tả.geotarget,devicetarget,languagetarget: quy tắc nhắm mục tiêu ở dạng mảng.
Phản hồi chứa id liên kết và shorturl đã sẵn sàng để chia sẻ. Lưu id nếu sau này ứng dụng của bạn cần thay đổi hoặc xóa liên kết.
5. Đọc và quản lý liên kết
GET /api/urls: danh sách các liên kết có phân trang (tham sốpage,limit,order).GET /api/url/{id}: chi tiết của một liên kết cùng với số liệu thống kê ngắn gọn.PUT /api/url/{id}/update: thay đổi đích, bí danh hoặc cài đặt khác.DELETE /api/url/{id}/delete: xóa liên kết.
Các điểm cuối tương tự có sẵn cho mã QR, trang bio, chiến dịch, tên miền và pixel. Chúng tôi viết riêng các ví dụ mã bằng một số ngôn ngữ lập trình trong bài viết tạo liên kết ngắn thông qua API bằng PHP, Python và JavaScript.
6. Giới hạn tần suất
Mỗi gói có giới hạn yêu cầu mỗi phút. Tiêu đề phản hồi X-RateLimit-Limit và X-RateLimit-Remaining cho biết hạn ngạch còn lại và các yêu cầu vượt quá giới hạn sẽ nhận được HTTP 429. Các chiến lược xử lý vấn đề này sẽ được thảo luận trong bài viết giới hạn tần suất và xử lý lỗi.
7. Thực tiễn bảo mật khóa API
- Lưu trữ khóa trong biến môi trường hoặc trình quản lý bí mật, không phải trong kho lưu trữ mã.
- Không bao giờ sử dụng khóa trong JavaScript phía trình duyệt hoặc các ứng dụng di động được phân phối; tạo một phụ trợ trung gian.
- Tạo các khóa riêng biệt cho mỗi ứng dụng và thu hồi các khóa không sử dụng.
- Khuyến nghị chung về quản lý bí mật có thể được đọc tại Hướng dẫn quản lý bí mật của OWASP.
Bước tiếp theo
Sau yêu cầu thành công đầu tiên, bạn có thể tự động hóa việc tạo liên kết từ bảng tính thông qua Zapier và Google Sheetshoặc nhận thông báo nhấp chuột theo thời gian thực qua webhooks và Slack.
Câu hỏi thường gặp
API có sẵn trên gói Miễn phí không?
Quyền truy cập API có sẵn trên các gói Pro và Business. Gói Pro nhận được 60 yêu cầu mỗi phút và gói Business nhận được 300 yêu cầu mỗi phút. Thời gian dùng thử 7 ngày đối với các gói trả phí bao gồm quyền truy cập API đầy đủ để tích hợp thử nghiệm.
Điều gì sẽ xảy ra nếu khóa API của tôi bị rò rỉ?
Xóa ngay khóa khỏi menu Nhà phát triển và tạo khóa mới. Vì mỗi khóa là độc lập nên các hoạt động tích hợp khác sử dụng các khóa khác nhau sẽ không bị gián đoạn. Đồng thời kiểm tra nhật ký yêu cầu để xem có hoạt động đáng ngờ nào không.
API có hỗ trợ tạo mã QR và trang bio không?
Có. Ngoài các liên kết, còn có các điểm cuối cho mã QR, trang bio, chiến dịch, tên miền, pixel và số liệu thống kê. Tất cả các điểm cuối đều sử dụng cùng một xác thực Bearer và trả về JSON với cấu trúc thông báo và lỗi nhất quán.
API có thể được gọi từ ứng dụng di động hoặc trình duyệt JavaScript không?
Chúng tôi khuyên bạn không nên vì khóa API sẽ hiển thị với người dùng. Tạo điểm cuối trong chương trình phụ trợ của riêng bạn để lưu trữ khóa một cách an toàn và chuyển tiếp yêu cầu tới API Kencang.in.
