Agora é possível realizar o cadastro do certificado digital para os convênios através da API do Plug Boleto, o certificado digital é utilizado para realização de autenticação nos registros instantâneos por alguns bancos.
O cadastro de certificado também está disponível para ser realizado no portal do Plug Boleto, na opção de cadastro de convênio.
POST
Homologação:
https://homologacao.plugboleto.com.br/api/v1/certificado/convenio
Produção:
https://plugboleto.com.br/api/v1/certificado/convenio
Headers
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-sh | CNPJ ou CPF da Software House | 01001001000113 |
| token-sh | Token da Software House | f22b97c0c9a3d41ac0a3875aba69e5aa |
| cnpj-cedente | CNPJ ou CPF do Cedente | 01001001000113 |
Headers (Opcional)
Utilizar esses headers em caso de autenticação direto com as credenciais do cedente:
| Nome | Descrição | Exemplo |
| Content-Type | Indica o tipo de arquivo | application/json |
| cnpj-cedente | CNPJ do Cedente | 01001001000113 |
| token-cedente | Token do Cedente | f22b97c0c9a3d41ac0a3875aba69e5aa1 |
Body - (form-data)
| Campo | Tipo | Descrição | Tamanho |
| file | file | Arquivo em anexo do certificado. | |
| passwordCertificado | string | Senha do certificado. | 1 - 20 |
| apelidoCertificado | string | Apelido para o certificado. | 1 - 250 |
| emailCertificado | string | E-mail para receber notificações de quando o certificado estiver vencendo. | 1 - 100 |
| convenioId | string | Id do convênio |
Exemplo de preenchimento no Insomnia:
Retorno
Exemplo de retorno:
{
"_status": "sucesso",
"_dados": {
"id_cedente": 4,
"cpf_cnpj": "01001001000113",
"convenioId": "99999",
"certificado": "TESTANDO",
"data_vencimento": "2023-06-22T17:56:00.000Z"
}
}
Exemplo de retorno com erro:
{
"_status": "erro",
"_mensagem": "Erro de validação.",
"_dados": [
{
"_campo": "file",
"_erro": "Campo obrigatório!"
}
]
}
Comentários
0 comentário
Por favor, entre para comentar.