Centro de desarrolladores

Subir archivo

Pasos para subir un archivo

Paso 1:Obtener la dirección para subir el archivo. Utilice la URL de carga de archivos (fileUpload Url) obtenida a través de la interfaz para obtener la dirección de carga directa de archivos.
Paso 2:Subir el archivo. Utilice el flujo de archivos para subir el archivo a través de HTTP PUT utilizando la URL obtenida en el paso 1.

[Atención]: El contentType transmitido en el paso 1 debe ser consistente con el Content-Type transmitido en el encabezado del paso 2, de lo contrario, se producirá un error con el código 403.

[Atención]: contentMD5 no es un campo obligatorio. Si se transmiten contentMD5 y contentType a través del paso 1, también se deben transmitir Content-MD5 y Content-Type en los encabezados del paso 2, y deben ser consistentes.

Obtener la dirección para subir el archivo

POST /esignglobal/v1/files/getUploadUrl

Descripción de la interfaz

Obtenga la dirección para subir archivos a través de esta interfaz

Parámetros de solicitud

Nombre del parámetro

Tipo

Obligatorio

Descripción

fileName

string

true

Nombre del archivo

【Nota】: Debe incluir la extensión del archivo, de lo contrario, la verificación posterior del sobre no pasará.

Ejemplo: nombre del contrato 1.pdf 

Notas adicionales:

(1) El nombre de la extensión del archivo en este campo debe ser consistente con la extensión real del archivo. Por ejemplo, si el tipo de archivo cargado es un archivo PDF, este parámetro debe ser "xxx.pdf", no "xxx.docx".

(2) El nombre del archivo no puede contener los siguientes 9 caracteres especiales: /\:*"<>|? y todos los emojis

(3) Solo se admite el formato de archivo .pdf

contentMD5

string

false

Valor Content-MD5 del archivo

Notas adicionales:

Primero debe obtener la matriz binaria de 128 bits del MD5 del archivo y luego realizar la codificación Base64 en este binario.

【Nota】 Si se transmite el valor de este parámetro, el Content-MD5 del archivo cargado en el paso dos también debe transmitir el mismo valor

contentType

string

true

Tipo de contenido

【Nota】 El Content-Type del archivo cargado en el paso dos también debe transmitir el mismo valor

Ejemplo de solicitud

{
  "fileName": "测试.pdf",
  "contentType": "application/pdf"
}

Parámetros de respuesta

Nombre del parámetro

Tipo

Descripción

fileKey

string

fileKey del archivo

fileName

string

Nombre del archivo

fileUploadUrl

string

Dirección de carga del archivo, válida por 60 minutos

【Nota】 Después de la fecha de vencimiento, vuelva a solicitar la interfaz para obtener la dirección de carga

Ejemplo de respuesta

{
    "code": "0",
    "data": {
    "fileKey": "xxxxxxxxx",
      "fileName": "签署.pdf",
      "fileUploadUrl": "文件上传地址"
  },
  "message": "成功"
}

 

Subir archivo

La URL de carga de archivos obtenida a través de la interfaz "Obtener dirección de carga de archivos".

Descripción de la interfaz

A través de la URL de carga de archivos (dirección de carga de archivos) obtenida, utilice el método de solicitud PUT para cargar el flujo de archivos (flujo de bytes binarios) al servidor.

Parámetros de la solicitud

1. Headers

Nombre del parámetro

Tipo

Obligatorio

Descripción

Content-MD5

string

false

Debe coincidir con el valor contentMD5 en el cuerpo de la solicitud de [Obtener dirección de carga de archivos]

Content-Type

string

true

Tipo MIME del archivo de destino

Notas adicionales:

Puede rellenar application/octet-stream o application/pdf, que debe ser coherente con los parámetros de solicitud de la interfaz para obtener la dirección de carga

2. HTTP BODY:Flujo de bytes binarios del archivo que se va a cargar
3. Método de codificación:

Ejemplo de solicitud

fileName = URLEncoder.encode(fileName, "UTF-8");
// replace special characters
fileName = fileName
  .replaceAll("\\+", "%20")
  .replaceAll("%28", "(")
  .replaceAll("%29", ")")
  .replaceAll("%27", "'")
  .replaceAll("%21", "!")
  .replaceAll("%7E", "~");

Ejemplo de respuesta

http_status: 200

 

Obtener la dirección para subir el archivo
Descripción de la interfaz
Parámetros de solicitud
Ejemplo de solicitud
Parámetros de respuesta
Ejemplo de respuesta
Subir archivo
Descripción de la interfaz
Parámetros de la solicitud
Ejemplo de solicitud
Ejemplo de respuesta