Central do desenvolvedor

Carregar ficheiro

Passos para carregar ficheiros

Passo 1:Obter o endereço de carregamento do ficheiro. Utilize o URL de carregamento direto de ficheiros obtido através da interface de obtenção do endereço de carregamento direto de ficheiros.
Passo 2:Carregar ficheiro. Utilize o URL obtido no passo 1 para carregar o fluxo de ficheiro através do método HTTP PUT.

【Atenção】: O contentType transmitido no passo 1 deve ser consistente com o Content-Type transmitido no cabeçalho no passo 2, caso contrário, ocorrerá um erro com o código de erro 403.

【Atenção】: contentMD5 não é um campo obrigatório. Se contentMD5 e contentType forem transmitidos através do passo 1, Content-MD5 e Content-Type também devem ser transmitidos nos cabeçalhos do passo 2 e devem permanecer consistentes

Obter o endereço de carregamento do ficheiro

POST /esignglobal/v1/files/getUploadUrl

Descrição da interface

Obtenha o endereço de carregamento do ficheiro através desta interface

Parâmetros de pedido

Nome do parâmetro

Tipo

Obrigatório

Descrição

fileName

string

true

Nome do ficheiro

【Atenção】: Deve incluir a extensão do ficheiro, caso contrário, a iniciação subsequente do envelope não passará na verificação.

Exemplo: nome_contrato1.pdf 

Observações adicionais:

(1) A extensão do ficheiro neste campo deve ser consistente com a extensão real do ficheiro. Por exemplo, se o tipo de ficheiro carregado for um ficheiro PDF, este parâmetro deve ser transmitido como “xxx.pdf”, e não como “xxx.docx”.

(2) O nome do ficheiro não pode conter os seguintes 9 caracteres especiais: /\:*"<>|? e todos os emojis

(3) Apenas suporta o formato de ficheiro .pdf

contentMD5

string

false

Valor Content-MD5 do ficheiro

Observações adicionais:

É necessário obter primeiro o array binário de 128 bits do MD5 do ficheiro e, em seguida, codificar este binário em Base64.

【Atenção】Se este parâmetro for transmitido, o Content-MD5 do ficheiro carregado no passo dois também deve transmitir o mesmo valor

contentType

string

true

Tipo de conteúdo

【Atenção】O Content-Type do ficheiro carregado no passo dois também deve transmitir o mesmo valor

Exemplo de Pedido

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

Parâmetros de Resposta

Nome do Parâmetro

Tipo

Descrição

fileKey

string

fileKey do ficheiro

fileName

string

Nome do ficheiro

fileUploadUrl

string

Endereço de carregamento do ficheiro, válido por 60 minutos

【Atenção】 Após a expiração, solicite novamente a interface para obter o endereço de carregamento

Exemplo de Resposta

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

 

Carregar ficheiro

O fileUpload Url obtido através da interface “Obter endereço de carregamento de ficheiro”.

Descrição da Interface

Através do fileUpload Url (endereço de carregamento de ficheiro) já obtido, utilize o método de pedido PUT para carregar o fluxo de ficheiro (fluxo de bytes binários) para o servidor.

Parâmetros do pedido

1. Cabeçalhos

Nome do parâmetro

Tipo

Obrigatório

Descrição

Content-MD5

string

false

Consistente com o valor contentMD5 no corpo do 【Obter endereço de carregamento de ficheiro】

Content-Type

string

true

Tipo MIME do ficheiro de destino

Nota adicional:

Pode preencher application/octet-stream ou application/pdf, que deve ser consistente com os parâmetros de pedido da interface de obtenção de endereço de carregamento

2. CORPO HTTP:Fluxo de bytes binários do ficheiro a carregar
3. Método de codificação:

Exemplo de pedido

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

Exemplo de resposta

http_status: 200

 

Obter o endereço de carregamento do ficheiro
Descrição da interface
Parâmetros de pedido
Exemplo de Pedido
Parâmetros de Resposta
Exemplo de Resposta
Carregar ficheiro
Descrição da Interface
Parâmetros do pedido
Exemplo de pedido
Exemplo de resposta