API nhãn hoàn trả cho hệ thống production
Tạo nhãn hoàn trả từ dữ liệu backend có cấu trúc, không cần browser. gPdf xử lý PDF rendering; logic nghiệp vụ nằm trong hệ thống của bạn.
/api/v1/pdf/render Tạo nhãn hoàn trả thành PDF có thể tái tạo từ dữ liệu có cấu trúc. gPdf render tài liệu; hệ thống của bạn giữ ngữ nghĩa dữ liệu và trạng thái quy trình.
Khi nào dùng API này
- Backend đã có dữ liệu nhãn hoàn trả và cần phản hồi PDF ổn định.
- Bạn muốn tránh Chromium hoặc HTML-to-PDF cho tài liệu vận hành.
- Bạn cần output lặp lại được cho in lại, audit hoặc batch.
Những gì không thay thế
- gPdf không mua vận chuyển, khai thuế, tạo đơn hàng ngoài hoặc đóng vai trò hệ thống thuế.
- Không thay thế validation dữ liệu, business rules hoặc tích hợp marketplace.
Endpoint cần gọi
/api/v1/pdf/render
JSON Render là đường mặc định cho workflow này.
/api/v1/template-render
Dùng khi workflow cần API liên quan, hợp đồng template hoặc truy vấn capability.
Request tối thiểu
/api/v1/pdf/render - nhãn hoàn trả
{
"pages": [
{
"size": "label_4_6_in",
"elements": [
{
"type": "text",
"x": 5,
"y": 8,
"content": "RETURN TO",
"style": { "font_size": 9, "font_family": "NotoSans-Regular" }
},
{
"type": "text",
"x": 5,
"y": 18,
"content": "Acme Returns\n500 Dock Door 4\nColumbus OH 43215",
"style": { "font_size": 11, "font_family": "NotoSans-Regular" }
},
{
"type": "barcode",
"format": "code128",
"content": "RMA-2026-77881",
"x": 5,
"y": 70,
"width": 88,
"height": 20,
"barcode_text": { "enabled": true, "position": "bottom" }
}
]
}
]
}
gPdf xử lý gì
- PDF rendering cho nhãn hoàn trả từ request có cấu trúc.
- Text, bảng, đường kẻ, barcode, trang, metadata và tùy chọn output theo request.
- Output deterministic cho retry, in lại và audit.
Hệ thống của bạn quản lý gì
- Dữ liệu đúng của nhãn hoàn trả, business rules và trạng thái vận hành.
- Authentication, lưu trữ, workflow bên ngoài và kiểm tra với hệ thống nhận.
Checklist production
- Test bằng dữ liệu thật và hệ thống sẽ nhận PDF.
- Lưu request ID và bằng chứng validation cho support, audit và in lại.
- Chuyển layout đã duyệt thành template khi nhiều hệ thống dùng lại.
Ranh giới cam kết
- gPdf render PDF nhãn; không mua vận chuyển, không tạo shipment và không chứng nhận carrier.
- Payload, máy in, giấy nhãn, routing và scan test thuộc hệ thống của bạn.
Dạng API
API nhãn hoàn trả là workflow production chạy trên public APIs của gPdf. Request mô tả dữ liệu, layout, settings và các phần PDF cần render. gPdf tạo PDF; hệ thống của bạn giữ ngữ nghĩa nghiệp vụ.
Chọn endpoint
Endpoint mặc định của workflow này là /api/v1/pdf/render. Dùng Template Render khi layout đã duyệt và tái sử dụng giữa nhiều hệ thống. Chỉ dùng E-Invoice Render khi cần gói Factur-X / ZUGFeRD PDF/A-3b với EN 16931 CII XML nhúng.
Kiểm tra trước production
Kiểm tra nhãn hoàn trả bằng dữ liệu thật và downstream systems. Lưu request ID, output đã render và bằng chứng validation cho support, audit và in lại.
FAQ
- Đây có phải endpoint riêng không?
- API nhãn hoàn trả ánh xạ workflow vào một API công khai của gPdf. Trang này chỉ rõ path cần gọi và request phải sở hữu dữ liệu gì.
- Có dùng templates được không?
- Có. Dùng JSON Render khi layout còn thay đổi; dùng Template Render khi layout đã duyệt và callers chỉ gửi dữ liệu nghiệp vụ.
- Cần kiểm tra gì trước production?
- Kiểm tra bằng dữ liệu thật và printer, scanner, validator, kế toán hoặc marketplace tùy workflow.