Referência de endpoints da Sign API

Esta página documenta todos os endpoints da Sign API. Para informações sobre autenticação e o formato de resposta, consulte a visão geral da Sign API.

Certificados

Listar certificados disponíveis

Retorna a lista de certificados aos quais o usuário autenticado tem acesso.

GET /signapi/v1/certificate/list

Parâmetro	Valor
Autenticação	Authorization: Bearer SEU_ACCESS_TOKEN
Body	—

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": [
    {
      "id": 0,
      "alias": "string",
      "thumbprint": "string",
      "pinPolicy": "NoPIN",
      "requireUsageReason": true
    }
  ]
}

Assinatura

Assinar um documento

Assina um documento e retorna o arquivo assinado.

POST /signapi/v1/sign/document

Parâmetro	Valor
Autenticação	Authorization: Bearer SEU_ACCESS_TOKEN
Content-Type	multipart/form-data
Resposta	Arquivo assinado

Esta requisição usa multipart/form-data com dois campos:

• jsonUploadData: Campo de formulário que contém o JSON serializado (veja o exemplo abaixo).
• file: O documento a ser assinado.

{
  "certificateId": 11,
  "pin": null,
  "reason": null,
  "visualSignature": {
    "x": 316,
    "y": 843,
    "width": 385,
    "height": 96,
    "imageBase64": "[IMAGE_IN_B64]",
    "pages": [1]
  }
}

O campo visualSignature é opcional.

Assinar um hash

Assina um hash de dados e retorna a assinatura resultante.

POST /signapi/v1/sign/hash

Parâmetro	Valor
Autenticação	Authorization: Bearer SEU_ACCESS_TOKEN
Content-Type	application/json

Body

{
  "dataInBase64": "string",
  "hashAlgorithm": "SHA256",
  "padding": "PKCS1",
  "certificate": "string",
  "pin": "string",
  "usageReason": "string"
}

Campo	Tipo	Descrição
dataInBase64	string	Dados a assinar, codificados em Base64.
hashAlgorithm	string	Algoritmo de hash. Valores válidos: MD5, SHA1, SHA224, SHA256, SHA384, SHA512.
padding	string	Tipo de padding. Valores válidos: PKCS1, PSS, OAEP.
certificate	string	Thumbprint do certificado a usar.
pin	string	PIN do certificado, se necessário.
usageReason	string	Motivo de uso, se o certificado exigir.

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": "string"
}

O campo data contém a assinatura resultante codificada em Base64.

Perfil de assinatura

Os endpoints de perfil permitem gerenciar a configuração de assinatura padrão do usuário: o certificado pré-selecionado, se uma imagem de assinatura ou texto informativo é incluído, e em quais páginas a assinatura é aplicada. Essa configuração é usada no fluxo de assinatura do Signtrust.

info

Estes endpoints estão disponíveis a partir da versão 4.42.0 e exigem um token de acesso obtido por meio do fluxo OAuth2 centralizado.

Obter perfil de assinatura

Retorna a configuração de assinatura salva para o usuário autenticado.

GET /signapi/v1/profile

Parâmetro	Valor
Autenticação	Authorization: Bearer SEU_ACCESS_TOKEN
Body	—

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {
    "hasSelectedCert": true,
    "selectedCertId": 0,
    "includeImage": true,
    "includeInfo": true,
    "infoItems": ["CERTIFICATE"],
    "pageType": "ALL",
    "pageRange": "string"
  }
}

Campo	Tipo	Descrição
hasSelectedCert	boolean	Indica se o usuário tem um certificado pré-selecionado.
selectedCertId	integer | null	ID do certificado pré-selecionado. Presente apenas se hasSelectedCert for true.
includeImage	boolean	Indica se uma imagem de assinatura personalizada é incluída.
includeInfo	boolean	Indica se informações textuais são incluídas na assinatura visual.
infoItems	array	Lista de elementos informativos incluídos. Valores válidos: CERTIFICATE, FRIENDLYNAME, DATE, THUMBPRINT.
pageType	string	Páginas onde a assinatura é aplicada. Valores válidos: CURRENT, LAST, ALL, RANGE.
pageRange	string | null	Intervalo de páginas no formato 1-3,5. Presente apenas se pageType for RANGE.

Salvar perfil de assinatura

Cria ou substitui a configuração de assinatura do usuário autenticado.

POST /signapi/v1/profile

Parâmetro	Valor
Autenticação	Authorization: Bearer SEU_ACCESS_TOKEN
Content-Type	application/json

Body

{
  "hasSelectedCert": true,
  "selectedCertId": 0,
  "includeImage": true,
  "includeInfo": true,
  "infoItems": ["CERTIFICATE"],
  "pageType": "ALL",
  "pageRange": null
}

Campo	Tipo	Obrigatório	Descrição
hasSelectedCert	boolean	Sim	Indica se um certificado é pré-selecionado.
selectedCertId	integer | null	Condicional	Obrigatório se hasSelectedCert for true.
includeImage	boolean	Sim	Indica se uma imagem de assinatura é incluída.
includeInfo	boolean	Sim	Indica se informações textuais são incluídas.
infoItems	array	Condicional	Obrigatório se includeInfo for true. Deve conter pelo menos um elemento. Valores válidos: CERTIFICATE, FRIENDLYNAME, DATE, THUMBPRINT.
pageType	string	Sim	Páginas onde a assinatura é aplicada. Valores válidos: CURRENT, LAST, ALL, RANGE.
pageRange	string | null	Condicional	Obrigatório se pageType for RANGE. Formato: 1-3,5.

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {}
}

Excluir perfil de assinatura

Exclui a configuração de assinatura salva do usuário autenticado.

DELETE /signapi/v1/profile

Parâmetro	Valor
Autenticação	Authorization: Bearer SEU_ACCESS_TOKEN
Body	—

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {}
}

Imagem de assinatura

Estes endpoints permitem gerenciar a imagem personalizada sobreposta ao documento durante a assinatura (a representação visual da assinatura).

info

Estes endpoints estão disponíveis a partir da versão 4.42.0 e exigem um token de acesso obtido por meio do fluxo OAuth2 centralizado.

Obter imagem de assinatura

Retorna a imagem de assinatura do usuário autenticado.

GET /signapi/v1/profile/image

Parâmetro	Valor
Autenticação	Authorization: Bearer SEU_ACCESS_TOKEN
Body	—

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {
    "imageInBase64": "string"
  }
}

Fazer upload da imagem de assinatura

Faz upload ou substitui a imagem de assinatura do usuário autenticado.

PUT /signapi/v1/profile/image

Parâmetro	Valor
Autenticação	Authorization: Bearer SEU_ACCESS_TOKEN
Content-Type	application/json

Body

{
  "imageInBase64": "string"
}

O campo imageInBase64 deve conter a imagem codificada em Base64.

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {}
}

Excluir imagem de assinatura

Exclui a imagem de assinatura do usuário autenticado.

DELETE /signapi/v1/profile/image

Parâmetro	Valor
Autenticação	Authorization: Bearer SEU_ACCESS_TOKEN
Body	—

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {}
}

Configuração do SharePoint

Obter configuração do SharePoint

Retorna os parâmetros de configuração do SharePoint associados à instalação do Redtrust. Esses valores são usados para a integração do Signtrust com o SharePoint.

GET /signapi/v1/sp-config

info

Este endpoint está disponível a partir da versão 4.42.0 e exige um token de acesso obtido por meio do fluxo OAuth2 centralizado.

Parâmetro	Valor
Autenticação	Authorization: Bearer SEU_ACCESS_TOKEN
Body	—

Resposta

{
  "message": "string",
  "messageType": "SUCCESS",
  "errorCode": "OK",
  "data": {
    "sharepoint_clientid": "string",
    "sharepoint_tenantid": "string"
  }
}

Campo	Descrição
sharepoint_clientid	ID do cliente da aplicação registrada no Azure para a integração com o SharePoint.
sharepoint_tenantid	ID do tenant do Azure associado à organização.