上传业务数据

接口概述

该接口用于向系统上传业务数据。数据以 JSON 格式传输。

  • 请求方式POST

  • 请求 URLhttps://openapi.elven.com/open/v3/businessData

  • Content-Typeapplication/json

请求头参数

参数名
类型
必填
说明

elven-api-key

String

分配给您的API密钥

elven-api-sign

String

请求签名,用于验证请求合法性

elven-api-timestamp

String

请求时间戳,毫秒级

查看详细说明

请求参数

Body 参数(JSON 格式)

参数名
类型
必填
说明

businessDataTypeName

String

业务数据类型名称,需在系统中已创建

businessDataSourceName

String

业务数据来源名称,未创建则自动创建,类型为 openapi

type

String

数据类型,TRANSACTION 为业务交易数据,BALANCE业务余额数据,不传默认为 TRANSACTION

balanceTransformer

Object

业务余额字段类型的识别规则

businessDataList

Array

业务数据列表,每个元素为一个业务数据对象

balanceTransformer

定义业务余额数据类型的识别规则,只需要在第一次导入业务余额数据时必传

示例:

{ 
    "datetimeColumn": 1, 
    "timezone": "UTC", 
    "currencyColumn": 4, 
    "amountColumn": 8, 
    "auxiliaryTypeName": "User", 
    "auxiliaryValueColumn": 0 
} 
参数名
必填
说明

datetimeColumn

businessDataList下时间字段的下标

timezone

业务余额数据中时间对应的时区 具体介绍

currencyColumn

businessDataList币种字段的下标

amountColumn

businessDataList币种数量字段的下标

auxiliaryTypeName

辅助核算字段名称,请先在系统创建辅助核算类型

auxiliaryValueColumn

businessDataList辅助核算字段的下标

businessDataList 数组元素

businessDataList 中的每个元素都是一个 JSON 对象,包含您的业务数据字段。

示例:

[
    {"a": 100, "b": "buy", "c": "2024-07-01 22:33:44"},
    {"a": 100, "b": "sell", "c": "2024-07-01 23:33:44"},
    {"a": 100, "b": "buy", "c": "2024-07-02 06:33:44"}
]

请求示例

{
    "businessDataTypeName": "Settlement",
    "businessDataSourceName": "Settlement-2024-07",
    "businessDataList": [
        {"a": 100, "b": "buy", "c": "2024-07-01 22:33:44"},
        {"a": 100, "b": "sell", "c": "2024-07-01 23:33:44"},
        {"a": 100, "b": "buy", "c": "2024-07-02 06:33:44"}
    ]
}

响应参数

参数名
类型
说明

success

Boolean

上传任务是否成功

响应示例

{
    "success": true
}

在线调试

您可以通过 Apifox 服务进行接口的在线调试:https://zswsuv3jhf.apifox.cn/api-253901224

注意事项

  • 数据大小限制:请求体的数据大小限制为 100KB。如果超过 100KB,请减少 businessDataList 中的数据条数,或者联系 Elven 获取帮助。

  • Content-Type:请求必须使用 application/json 作为 Content-Type。

  • 业务数据类型:请确保提供的 businessDataTypeName 已经在系统中创建。

  • 业务数据来源businessDataSourceName 如果不存在,将自动创建,类型为 openapi

Last updated