Upload tài liệu
Endpoint
| Method | URL |
|---|---|
| POST | https://tpa.docbase.ai/api/v1/integrations/folders/{FolderID}/submissions |
Ví dụ
| Method | URL |
|---|---|
| POST | https://tpa.docbase.ai/api/v1/integrations/folders/1/submissions |
Params
| Tham số | Các giá trị đầu vào | Mô tả |
|---|---|---|
type | file / url / base64 (bắt buộc) | Loại nguồn dữ liệu gửi lên hệ thống. Chọn một trong ba giá trị tương ứng với cách cung cấp dữ liệu: tải tệp tin, gửi đường dẫn hoặc gửi chuỗi mã hóa Base64. |
sync | true / false | Đặt true nếu cần API trả về kết quả ngay lập tức. Mặc định là false nếu không truyền tham số này. |
services | "categorize""ocr_procession""expense_calculation" | Danh sách các service mà hồ sơ sẽ được xử lý qua. Có thể sử dụng một hoặc nhiều service, nhưng phải đúng tên và đúng thứ tự. Các service được phân tách bằng dấu ,. |
Body
Với type = base64
Header: Content-Type: application/json
{
"files": [
{
"name": "string",
"file_data": "base64"
}
],
"external_id": "string",
"policy_number": "string",
"claim_number": "string",
"card_number": "string",
"customer_name": "string",
"user_code": "string"
}
Với type = url
Header: Content-Type: application/json
{
"files": [
{
"name": "string",
"file_url": "url"
}
],
"external_id": "string",
"policy_number": "string",
"claim_number": "string",
"card_number": "string",
"customer_name": "string",
"user_code": "string"
}
Ý nghĩa các tham số
| Tham số | Kiểu dữ liệu | Mô tả |
|---|---|---|
files | list (bắt buộc) | Danh sách link file tải lên |
external_id | string | ID do người dùng định nghĩa, được dùng như một phần của bộ hồ sơ |
policy_number | string | Số đơn bảo hiểm do người dùng định nghĩa |
claim_number | string | Số hồ sơ bảo hiểm do người dùng định nghĩa |
card_number | string | Số thẻ do người dùng định nghĩa |
customer_name | string | Tên khách hàng |
user_code | string | Mã cán bộ xử lý hồ sơ |
Với type = file
Header: Content-Type: multipart/form-data
| Tham số | Kiểu dữ liệu | Mô tả |
|---|---|---|
files | file | Danh sách tệp tải lên |
external_id | text | ID do người dùng định nghĩa, được sử dụng như một phần của bộ hồ sơ |
card_number | text | Số thẻ do người dùng định nghĩa |
claim_number | text | Số hồ sơ bảo hiểm do người dùng định nghĩa |
policy_number | text | Số đơn bảo hiểm do người dùng định nghĩa |
user_code | text | Mã cán bộ xử lý hồ sơ |
customer_name | text | Tên khách hàng |
Mô tả
Trả về trạng thái của các file được truyền vào.
Response
Nếu không truyền tham số sync hoặc để sync = false
{
"success_submission_id": 123,
"error_file_name": [],
"error_messages": []
}
| Tham số | Kiểu dữ liệu | Mô tả |
|---|---|---|
| success_submission_ids | int | ID của các hồ sơ đã tạo thành công |
| error_file_name | list | Danh sách tên file tải không thành công |
| error_messages | list | Danh sách file lỗi và mô tả lỗi |
Nếu truyền tham số sync = true
Kết quả trả về giống API lấy dữ liệu chi tiết của bộ hồ sơ.