Tài liệu API
Có câu hỏi? Liên hệ với chúng tôi.
Tất cả các yêu cầu API phải được thực hiện qua HTTPS và sử dụng HTTP Basic Auth với các thông tin xác thực sau:
Username: API KEY
Password: Not needed
Ví dụ
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://en.wikipedia.org/wiki/Eclipse
Cờ | Mô tả |
|---|---|
-u | Truyền thông tin xác thực cơ bản, dấu hai chấm sau khóa API ngăn cURL yêu cầu mật khẩu. |
-đ | gửi dữ liệu trong yêu cầu POST |
Trong trường hợp thành công, bạn sẽ nhận được phản hồi HTTP với trạng thái 302 (Chuyển hướng) và thông tin JSON sẽ nằm trong phần nội dung của phản hồi.
# HTTP RESPONSE
# HEADERS (some of headers are ommited)
Content-Type: application/json; charset=utf-8
Status: 302 Found
Location: https://v.printfriendly.com/system/pdfs/pdf_1480936999_755625A4.pdf
# BODY
{"success":"Redirect to https://v.printfriendly.com/system/pdfs/pdf_1480947535_6e7ecaA4.pdf"}
Phiên bản API
Phiên bản hiện tại của API là 1.0.
Phiên bản chính của API phải được cung cấp trong URL dưới dạng 'v' và số, ví dụ: v1, v2, v3.
Ví dụ
https://api.printfriendly.com/v2/pdf/create
https://api.printfriendly.com/v2/html/create
Phương pháp API
Phương pháp | Đầu vào | Đầu ra |
|---|---|---|
PDF / tạo | URL / HTML | HTML |
html / tạo | URL / HTML |
Tham số
Bạn phải cung cấp tham số page_url hoặc html. Tất cả các tham số khác là tùy chọn.
Tham số | Giá trị |
|---|---|
URL trang | URL của trang đích |
HTML | Nội dung HTML của trang đích |
css_url | URL cho tệp CSS tùy chỉnh |
header_image_url | URL cho hình ảnh tiêu đề tùy chỉnh |
Văn bản tiêu đề | Chuỗi Văn Bản |
Tất cả các ví dụ dưới đây được cung cấp cho phương pháp "pdf/create" và cũng hoạt động cho phương pháp "html/create".
Ví dụ với tham số page_url
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://test.test /
-d css_url=https://my-site.com/pdf_style.css /
-d header_text='My Custom Header'
Trong trường hợp thành công, bạn sẽ nhận được phản hồi HTTP với trạng thái 302 (Chuyển hướng) và thông tin JSON sẽ nằm trong phần nội dung của phản hồi.
Ví dụ với các tham số html
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d html='<html><body><h1>Title</h1><p>Text text text text text text text text text</p></body></html>'
Trong trường hợp thành công, bạn sẽ nhận được phản hồi HTTP với trạng thái 200 và nội dung PDF/HTML trong phần thân phản hồi.
Lỗi
PrintFriendly sử dụng các mã trạng thái thông thường và phản hồi JSON để cung cấp chi tiết lỗi.
Mã trạng thái
Trạng thái | Mô tả |
|---|---|
200 OK | Mọi thứ hoạt động tốt. |
400 Yêu Cầu Không Hợp Lệ | Đã xảy ra lỗi. Xem chi tiết trong JSON. |
401 Không được phép | 401 Không được phép |
404 Không tìm thấy | 404 Không tìm thấy |
429 Quá nhiều yêu cầu | 429 Quá nhiều yêu cầu |
Tất cả các phản hồi không thành công (không phải Trạng thái 302 OK) đều có phần nội dung JSON chứa chi tiết lỗi, bao gồm loại lỗi và thông báo.
Các loại lỗi
Loại | Mô tả |
|---|---|
Xác thực thông số | Xác thực tham số thất bại. |
Tên miền bị cấm | Tên miền này bị cấm tạm thời. |
Không parse được | Không thể phân tích trang. Chúng tôi không thể xác định nội dung của trang này. |
Lỗi lấy dữ liệu | Không thể tải trang. Hãy kiểm tra xem URL có thể truy cập được và thử lại. |
tải cao | Xác thực tham số thất bại. |
Phần mở rộng tệp không hợp lệ | Chỉ hỗ trợ trang web. Đây là tệp PDF/TXT hoặc hình ảnh (JPG, PNG, GIF). |
trang lớn | Trang đích vượt quá 2Mb. Các trang lớn không được hỗ trợ. |
nền tảng an ninh | Nền tảng bảo mật chặn chúng tôi truy cập trang này. |
hết giờ | Hết thời gian chờ. Công cụ không thể xử lý trang trong vòng 30 giây. Vui lòng thử lại sau. |
bao quát | Lỗi không mong muốn. Vui lòng thử lại sau. |
Ví dụ
curl https://api.printfriendly.com/v1/pdfs/create /
-u your_api_key: /
-d page_url=https://test.test
Đầu vào HTML
# HTTP RESPONSE
# HEADERS (some of headers were ommited)
Content-Type: application/json; charset=utf-8/
Status: 400 Bad Request
# BODY (JSON)
{"status":"failed","message":"Print technology unable to download or parse content"}
Giới hạn tốc độ yêu cầu
API có giới hạn 60 yêu cầu mỗi phút. Nếu bạn vượt quá giới hạn này, bạn sẽ nhận được phản hồi với Trạng thái: 429 Quá nhiều yêu cầu.
Tiêu đề | Mô tả |
|---|---|
Giới hạn tốc độ-X | Giới hạn tổng số yêu cầu cho giai đoạn hiện tại. |
X-Giới hạn còn lại | Yêu cầu còn lại cho kỳ hiện tại. |
Đặt lại X-RateLimit | Số giây cho đến khi kết thúc giai đoạn hiện tại. |
Ví dụ với tham số page_url
# HEADERS (some of headers were ommited)
Status: 429 Too Many Requests
X-RateLimit-Limit: 60
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 20
# BODY (JSON)Empty