API
New Horizon
Log In
API

Assinar CMS/CAdES utilizando certificado em arquivo (Passo único) ⚠️

post
https://example.com/fw/v1/cms/pkcs12/assinaturas

⚠️ Disponível somente para implantação on-premises

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Nome do arquivo pfx/p12

string
required

String representando o tipo de perfil desejado para a assinatura a ser gerada. [Valores disponíveis: BASIC, TIMESTAMP, COMPLETE, ADRB, ADRT, ADRV, ADRC, ADRA, ETSI_B, ETSI_T, ETSI_LT e ETSI_LTA]. Aceita também os valores legados em português para os perfis de assinatura CMS básica.

string
required

String indicando qual será o formato de codificação dos dados a serem assinados. [Valores disponíveis: Base64]

string
required

String que representa o algoritmo de hash que será utilizado para gerar a assinatura. [Valores disponíveis: SHA1, SHA256 e SHA512].

string
required

Formato do processamento dos documentos recebidos na lista de hashes. [Valores disponíveis: HASH, ATTACHED e DETACHED].

boolean

Boolean representando se será realizado uma coassinatura. Valor padrão é false.

hashes
array of strings
required

Array de strings com os conteúdos a serem assinados. Atualmente se o formatoAssinatura for HASH deve ser enviado os resumos criptográficos (hashes) calculados a partir do documento original. Caso formatoAssinatura seja algum dos demais valores (ATTACHED ou DETACHED), deve ser enviado o conteúdo original do documento que se deseja assinar.

hashes*
comentarios
array of strings

Array de strings com um conjunto de comentários que serão inseridos na assinatura. Parâmetro Opcional, mas se utilizado deve ser enviado um comentario para cada assinatura a ser realizada.

comentarios
nomeDocumentos
array of strings

Array de strings com um conjunto de nomes que serão inseridos na assinatura como nome do documento. Parâmetro Opcional, mas se utilizado deve ser enviado um nome para cada assinatura a ser realizada.

nomeDocumentos
string

Quando enviado, este parâmetro define o OID da política de assinatura a ser usada com perfil de assinatura selecionado.

Headers
string

Token de acesso aos serviços BRy emitido no BRy Cloud. É obrigatório em todas as requisições ao HUB. Para utilizar esta documentação é necessário inserir o token em Authorize.

string
required

Senha do PKCS12 (.pfx/.p12) configurado para a assinatura. Deve ser fornecido em formato Base64.

Responses

default

Para mais detalhes sobre as Respostas: link para as respostas de erro ou no formato properties

Updated about 1 year ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago