Import Business Data

APIs

API Overview

This API is used to upload business data to the system. Data should be transmitted in JSON format.

  • Request Method:POST

  • Request URL:https://openapi.elven.com/open/v3/businessData

  • Content-Type:application/json

Request Headers

Parameter Name
Type
Required
Description

elven-api-key

String

Yes

The API key assigned to you

elven-api-sign

String

Yes

Request signature, used to verify the legitimacy of the request

elven-api-timestamp

String

Yes

Request timestamp, in milliseconds

View Details

Request Parameters

Body Parameters (JSON Format)

Parameter Name
Type
Required
Description

businessDataTypeName

String

Yes

Business Data Type Name: Must already exist in the system.

businessDataSourceName

String

Yes

Business Data Source Name: If not already created, it will be automatically created with the type openapi

businessDataList

Array

Yes

Business Data List: Each element represents a business data object.

businessDataList:

Each element inbusinessDataList is a JSON object containing your business data fields.=

Example:

[
    {"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"}
]

Example Request

{
    "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"}
    ]
}

Response Parameters

Parameter Name
Type
Description

success

Boolean

Upload Task Status

Example Response

{
    "success": true
}

Notes

  • Data Size Limit: The maximum request body size is 100KB. If the data exceeds this limit, reduce the number of entries in businessDataList or contact Elven support for assistance.

  • Content-Type: The request must use application/json as the Content-Type.

  • Business Data Type: Ensure the provided businessDataTypeName already exists in the system.

  • Business Data Source: If businessDataSourceName does not exist, it will be automatically created with the type set to openapi.

Last updated