Pular para o conteúdo principal

Rotas do Certificado

Bruno Caldeef
Atualizado

Sumário

Cadastrar certificado

Agora é possível realizar o cadastro do certificado digital 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 cedente.

POST

 Homologação:

https://homologacao.plugboleto.com.br/api/v1/certificado

 Produção:

https://plugboleto.com.br/api/v1/certificado

 

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

 

Exemplo preenchimento Postman:

mceclip1.png

Retorno

 

Exemplo de retorno:

 

{
    "_status": "sucesso",
    "_dados": {
        "id_cedente": 4,
        "cpf_cnpj": "01001001000113",
        "certificado": "TESTANDO",
        "data_vencimento": "2021-07-07T17:56:00.000Z"
    }
}

 

 

Exemplo de retorno com erro:

 

{
    "_status": "erro",
    "_mensagem": "Erro de validação.",
    "_dados": [
        {
            "_campo": "file",
            "_erro": "Campo obrigatório!"
        }
    ]
}

Consultar certificado digital

 

Para consultar seu certificado digital cadastrado no Plugboleto é bem simples, basta realizar uma requisição GET na rota abaixo, com os seus dados de autenticação.

Com o resultado da consulta, é possível visualizar a data de vencimento do seu certificado.

 

GET

 Homologação:

https://homologacao.plugboleto.com.br/api/v1/certificado

 Produção:

https://plugboleto.com.br/api/v1/certificado

 

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

 

 

Retorno

 

Exemplo de retorno:

 

{
    "_status": "sucesso",
    "_dados": {
        "id_cedente": 4,
        "cpf_cnpj": "01001001000113",
        "certificado": "TESTANDO",
        "data_vencimento": "2021-07-07T17:56:00.000Z"
    }
}

 

 

Exemplo de retorno com erro:

 

{
    "_status": "erro",
    "_mensagem": "Acesso não autorizado.",
    "_dados": [
        {
            "_erro": "Cedente não encontrado."
        }
    ]
}

Cadastrar certificado para Convênio

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:

mceclip1.png

 

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!"
        }
    ]
}

 

Consulta de certificado por convênio

Após realizar o cadastro do certificado digital para os convênios através da API do Plug Boleto, existe a possibilidade de consultá-lo.

GET

 Homologação:

http://homologacao.plugboleto.com.br/api/v1/certificado/convenio/{IdConvênio}

 Produção:

http://plugboleto.com.br/api/v1/certificado/convenio/{IdConvênio}

 

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

 

Exemplo CURL

curl --request GET \
--url http://homologacao.plugboleto.com.br/api/v1/certificado/convenio/1291 \
--header 'Content-Type: application/json' \
--header 'cnpj-cedente: 01001001000113' \
--header 'cnpj-sh: 01001001000113' \
--header 'token-sh: f22b97c0c9a3d41ac0a3875aba69e5aa' \

 

Retorno

Exemplo de retorno:

{

  "_status": "sucesso",

  "_dados": {

    "id_cedente": 41,

    "cpf_cnpj": "01001001000113",

    "convenioId": "1291",

    "certificado": "CN=Pierre de Fermat, OU=, O=Lacuna Software, C=BR, S=, L=, E=, SE=00 ab 35 50 39 16 82 53 42 94 ed 5b 9f 45 55 8d 05",

    "data_vencimento": "2025-01-25T03:00:00.000Z"

  }

}

 

Exemplo de retorno com erro:

{

  "_status": "erro",

  "_mensagem": "Acesso negado.",

  "_dados": [

    {

      "_erro": "Conta do Convenio não encontrada"

    }

  ]

}

 

Consultar certificado de Convênio

Para consultar seu certificado digital cadastrado para o convênio no Plugboleto é bem simples, basta realizar uma requisição GET na rota abaixo informando o Id do convênio, com os seus dados de autenticação.

Com o resultado da consulta, é possível visualizar a data de vencimento do seu certificado.

 

GET

 Homologação:

https://homologacao.plugboleto.com.br/api/v1/certificado/convenio/:id

 Produção:

https://plugboleto.com.br/api/v1/certificado/convenio/:id

 

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 header 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

 

 

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": "Acesso não autorizado.",
    "_dados": [
        {
            "_erro": "Convênio não encontrado."
        }
    ]
}

 

Cadastrar certificado para PIX no Convênio

Se você utiliza a opção de bolecode para o Itaú, também pode realizar o upload de seu certificado do PIX através do endpoint citado abaixo.

O cadastro de certificado do PIX também está disponível para ser realizado no portal do Plug Boleto, na opção de cadastro de convênio, e aparecerá a opção ao definir bolecode como true.

POST

 Homologação:

https://homologacao.plugboleto.com.br/api/v1/certificado/convenio/pix

 Produção:

https://plugboleto.com.br/api/v1/certificado/convenio/pix

 

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.  
conveniopixchave string Chave PIX informada pelo banco.  

 

Exemplo de preenchimento no Insomnia:

 

 

Artigos relacionados

Comentários

0 comentário

Por favor, entre para comentar.