Thư viện tư liệuAPI thư viện tư liệu
Hướng dẫn
Ủy quyền tư liệu người thật
Tạo phiên quét mã người thật và xác nhận hoàn tất thu thập
Ủy quyền tư liệu người thật
Tư liệu người thật phải do bản thân người đó hoàn tất thu thập và ủy quyền trên điện thoại, không thể thay thế bằng việc tải ảnh thông thường.
Tạo phiên quét mã người thật
POST
/api/v1/materials/portrait/sessionsCách xác thực
Authorization: Bearer <API_KEY>.
Phần thân yêu cầu · application/json
| Tham số | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
continuous_create | boolean | Không | Khi là true, sau khi phân giải xong tiếp tục tạo phiên ủy quyền tiếp theo |
Ví dụ yêu cầu
curl -X POST "$LOCOPAL_BASE_URL/api/v1/materials/portrait/sessions" \
-H "Authorization: Bearer $LOCOPAL_API_KEY" \
-H "Content-Type: application/json" \
-d '{"continuous_create":false}'Tham số phản hồi
| Tham số | Kiểu | Mô tả |
|---|---|---|
code | integer | Khi thành công là 0 |
msg | string | Khi thành công là 真人授权会话已创建 |
data.session.authorization_url | string | Địa chỉ trang ủy quyền, chuyển thành mã QR giao cho người thật |
data.session.session_token | string | Khóa phiên, chỉ lưu ở máy chủ |
data.session.expires_in | integer | Thời hạn hiệu lực của phiên (giây) |
data.session.expire_time | string | Thời gian hết hạn của phiên (chuỗi thời gian ISO) |
Nội dung phản hồi
{
"code": 0,
"data": {
"session": {
"authorization_url": "https://授权页面地址",
"session_token": "session-token",
"expires_in": 600,
"expire_time": "2026-09-09T08:10:00.000Z"
}
},
"msg": "真人授权会话已创建"
}Không ghi session_token vào nhật ký, không gửi cho tài khoản khác hoặc lưu giữ lâu dài; khi phiên hết hạn hãy tạo lại.
Phản hồi lỗi
| HTTP | msg | Mô tả |
|---|---|---|
400 | 请求体必须是 JSON 对象 | Phần thân yêu cầu không phải JSON hợp lệ |
401 | Invalid token | Khóa API thiếu, sai hoặc đã hết hiệu lực |
503 | 素材服务暂不可用 | Kênh thu thập người thật chưa sẵn sàng, giữ thời gian yêu cầu rồi liên hệ hỗ trợ nền tảng |
Xác nhận hoàn tất quét mã người thật
POST
/api/v1/materials/portrait/resolveCách xác thực
Authorization: Bearer <API_KEY>.
Phần thân yêu cầu · application/json
| Tham số | Kiểu | Bắt buộc | Mô tả |
|---|---|---|---|
session_token | string | Có | data.session.session_token trả về khi tạo phiên quét mã |
Ví dụ yêu cầu
curl -X POST "$LOCOPAL_BASE_URL/api/v1/materials/portrait/resolve" \
-H "Authorization: Bearer $LOCOPAL_API_KEY" \
-H "Content-Type: application/json" \
-d '{"session_token":"session-token"}'Tham số phản hồi
| Tham số | Kiểu | Mô tả |
|---|---|---|
code | integer | Khi thành công là 0 |
msg | string | Khi thành công là 真人授权已完成 |
data.group.id | string | ID nhóm tư liệu người thật được tạo từ quá trình thu thập |
data.group.name | string | Tên nhóm |
data.group.type | string | Cố định là real |
data.group.description | string / null | Mô tả nhóm |
Nội dung phản hồi
{
"code": 0,
"data": {
"group": {
"id": "group-20260911034940-lrtht",
"name": "真人素材库",
"type": "real",
"description": null
}
},
"msg": "真人授权已完成"
}Sau khi phân giải thành công, gọi Đồng bộ trạng thái tư liệu và truy vấn danh sách tư liệu, đọc asset_id và status của tư liệu người thật.
Phản hồi lỗi
| HTTP | msg | Mô tả |
|---|---|---|
400 | 请求体必须是 JSON 对象 | Phần thân yêu cầu không phải JSON hợp lệ |
401 | Invalid token | Khóa API thiếu, sai hoặc đã hết hiệu lực |
503 | 素材服务暂不可用 | Phiên không tồn tại, chưa hoàn tất thu thập, hoặc kênh thu thập người thật chưa sẵn sàng |
Trang này có hữu ích không?
