Service Center

File Management

When adding a file, an error is reported that the fileKey does not exist, and it reports "File cannot be found."

Please check whether the fileUpload url obtained by using the interface for obtaining the file address has been used to upload the file stream in the HTTP PUT manner. If it has not been uploaded, please call the URL to upload the file.

 

How long is the downloadUrl from /esignglobal/v1/templates/fileFiling valid?

The generated file download link is valid for 60 minutes (only returned upon successful synthesis).

 

During the docking process, the file upload site https://file-sml.esignglobal.com/ is particularly slow, and the file upload is rather sluggish.

When docking and uploading files in the sandbox environment, it should be noted that its server is located in Singapore. When accessing it directly in China, the network is often unstable, and problems such as lagging, slow loading or being unable to access occur from time to time. In view of this, it is recommended to access it through a proxy in Singapore. This will help improve the unstable network situation and make it more convenient to use this file service.

 

The file upload fails after the OpenAPI call to obtain the file address is successful.

Step 1: Obtain the file upload address During the operation, you need to provide the relevant information in the following format to obtain the file upload address: { "fileName": "fengniantest.pdf", "contentType": "application/pdf" } Please note that although the file name here is "fengniantest.pdf", the content type (contentType) is specified as "application/pdf". Ensure that the relevant parameters are accurate. 

Step 2: Add request header information when directly uploading the file When performing a direct file upload operation, you need to add the information 'Content-Type: application/pdf' to the request headers (headers) to clarify the type of the uploaded file and ensure the smooth progress of the direct file upload operation.

 

Which file formats are supported for file upload via OpenAPI?

The following file formats are supported: PDF (.pdf), Word (.docx,.doc), RTF (.rtf), Excel (.xlsx,.xls), PowerPoint (.pptx,.ppt), WPS Writer (.wps), WPS Spreadsheets (.et), WPS Presentation (.dps), JPEG (.jpeg,.jpg), PNG (.png), BMP (.bmp), TIFF (.tiff), GIF (.gif), HTML (.html,.htm) and CSV (.csv).

 

 

Querying File Composition Task by Task ID: "File Conversion Failed: Network Address Access Failed"

When document conversion times out, it often leads to file composition failure. In this case, you can re-invoke the template to generate the file and then call the file composition task query interface to check if the file composition was successful. If the file composition still fails after performing the above steps, you can directly contact the technical support team for assistance from professional technicians.

 

 

If both the invocation of the file upload address retrieval and the direct file upload parameters are correct, but the direct file upload still returns a "403 Forbidden: "<?xml version="1.0" encoding="UTF-8"?><EOL><Error><EOL> <Code>SignatureDoesNotMatch</Code><EOL> <Message>The request signature we calculated does not match the signature you provided. Check your key and signing method.</Message><EOL> <RequestId>68440537821143343409E1E9</RequestId><EOL>"

If the contentType passed in step one matches the Content-Type transmitted in the Header in step two, and the file is successfully uploaded directly via Postman using the fileUploadUrl, but the customer's code still encounters errors during the call, and breakpoint checks confirm that the parameters are being passed correctly, there may be a compatibility issue with the customer's framework. It is suggested that the customer refer to the following code example for direct file upload:

Reference code:

java

// method of calling(set Java as example)
Response response = HttpUtil.sendRequest(
    "uploadUrl",                // upload API URL
    new File("文件路径/xxx.pdf"), // file to be uploaded
    "application/pdf",          // content type
    new HashMap<>()             // optional request header parameters (pass empty if none)
);

Key Points:

  1. Parameter Consistency Verification: Ensure that the Content-Type parameter in the code (e.g., "application/pdf") is exactly consistent with the interface requirements, including case and format (e.g., application/jsonmust be strictly distinguished fromapplication/JSON).
  2. Framework Compatibility Troubleshooting: If the code logic is correct but errors still occur, try bypassing the customer's framework and directly use a native HTTP client (such as Java's URLConnection or Python's requests) for verification, to identify whether there are compatibility issues with how the framework handles request headers and file streams.
  3. Error Log Localization: It is recommended that customers capture and record complete error information (such as HTTP status codes, server response messages) to further diagnose specific error causes at the network layer or on the server side. This approach, by standardizing parameter passing and simplifying the call chain, can effectively isolate framework-related issues and quickly pinpoint the root cause of direct file upload failures.