A API Ceape Brasil foi desenvolvida de acordo com os melhores padrões REST.
As operações são feitas por requisições aos endpoints, de acordo com os verbos HTTP, com corpos de mensagem em JSON. As respostas podem ser interpretadas através do código de status HTTP. Isso permite que quaisquer aplicações consumam a API de forma simples e clara, independente da linguagem utilizada.
Confira a baixo a documentação
Para realizar qualquer requisão referente ao Endpoint Seguros é necessário que você possua o seu TOKEN API.
O seu TOKEN API deverá ser informado como parâmetro na URL da Requisição (seguindo o exemplo no tópico de Requisição)
| Nome do Parâmetro | Tipo | Obrigatório |
|---|---|---|
| tokenApi | String | SIM |
Este Endpoint retornará uma lista de categorias de seguros que o Ceape Brasil atualmente oferece para a idade do cliente. Ou seja se o cliente possui 75 anos de idade, a API retornará a lista de categoria de seguros que atendem até 75 anos de idade.
A API Ceape Brasil retornará um JSON semelhante ao descrito no exemplo abaixo.
[
{
"Id":20,
"Nome":"Seguro de Vida & Saúde",
"Descricao":"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been",
"Status":1,
"UrlBanner":"https://api.ceapebrasil.org.br/Images/url-banner.jpg",
"UrlIcone":"https://api.ceapebrasil.org.br/Images/url-banner.jpg",
"ListaSeguros": [
{
"Id":49,
"Nome":"SEGURO VIDA & TELEMEDICINA - P1",
"TipoValor":1,
"Preco":399.0,
"Ativo":1,
"Compulsorio":0,
"ModoPgto":0,
"ValorIOF":1.50,
"ProLabore":"30%",
"NumApolice":"xxxxxxx-xxxx-xxxxx-xxx",
"LkpSigla":"PLANO-2",
"LkpCobertura":"Seguro de Vida & Saúde",
"Categoria":4,
"ValorSorteio":10000.00,
"IdadeMax":0.00,
"IdadeMin":0.00,
"ValorMinimo":0.00,
"ValorMaximo":0.00,
"Descricao":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"DescricaoCobertura":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"MaxParcelas":12,
"MinParcelas":2,
"Parcelas":12,
"ListaCobertura": [
{
"Id":1,
"Descricao":"Assistência residencial completa",
"HasDetalhe":true,
"Detalhe":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
},
{
"Id":2,
"Descricao":"Rede de Assistência e Serviços 24h",
"HasDetalhe":false,
"Detalhe":""
},
{
"Id":3,
"Descricao":"Sorteio Mensal de R$15.500,00",
"HasDetalhe":false,
"Detalhe":""
}
]
}
]
},
{
"Id":20,
"Nome":"Seguro de Vida & Saúde",
"Descricao":"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been",
"Status":1,
"UrlBanner":"https://api.ceapebrasil.org.br/Images/url-banner.jpg",
"UrlIcone":"https://api.ceapebrasil.org.br/Images/url-banner.jpg",
"ListaSeguros": [
{
"Id":49,
"Nome":"SEGURO VIDA & TELEMEDICINA - P1",
"TipoValor":1,
"Preco":399.0,
"Ativo":1,
"Compulsorio":0,
"ModoPgto":0,
"ValorIOF":1.50,
"ProLabore":"30%",
"NumApolice":"xxxxxxx-xxxx-xxxxx-xxx",
"LkpSigla":"PLANO-3",
"LkpCobertura":"Seguro de Vida & Saúde",
"Categoria":4,
"ValorSorteio":10000.00,
"IdadeMax":0.00,
"IdadeMin":0.00,
"ValorMinimo":0.00,
"ValorMaximo":0.00,
"Descricao":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"DescricaoCobertura":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"MaxParcelas":12,
"MinParcelas":2,
"Parcelas":12,
"ListaCobertura": [
{
"Id":1,
"Descricao":"Assistência residencial completa",
"HasDetalhe":true,
"Detalhe":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
},
{
"Id":2,
"Descricao":"Rede de Assistência e Serviços 24h",
"HasDetalhe":false,
"Detalhe":""
},
{
"Id":3,
"Descricao":"Sorteio Mensal de R$15.500,00",
"HasDetalhe":false,
"Detalhe":""
}
]
}
]
},
]
Código HTTP da Requisição: 200
Caso não seja possivel localizar a lista de categorias, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Não foi possível localizar a lista de categorias em nossa base de dados."
}
Código HTTP da Requisição: 400
Este Endpoint retornará uma lista de seguros de acordo com a categoria informada no campo id na url da requisição. Todos os seguros retornados neste Endpoint terão o campo IdadeMin e IdadeMax como intervalo da idade do cliente.
A API Ceape Brasil retornará um JSON semelhante ao descrito no exemplo abaixo.
[
{
"Id":49,
"Nome":"SEGURO VIDA & TELEMEDICINA - P1",
"TipoValor":1,
"Preco":399.0,
"Ativo":1,
"Compulsorio":0,
"ModoPgto":0,
"ValorIOF":1.50,
"ProLabore":"30%",
"NumApolice":"xxxxxxx-xxxx-xxxxx-xxx",
"LkpSigla":"PLANO-2",
"LkpCobertura":"Seguro de Vida & Saúde",
"Categoria":4,
"ValorSorteio":10000.00,
"IdadeMax":0.00,
"IdadeMin":0.00,
"ValorMinimo":0.00,
"ValorMaximo":0.00,
"Descricao":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"DescricaoCobertura":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"MaxParcelas":12,
"MinParcelas":02,
"Parcelas":12,
"ListaCobertura": [
{
"Id":1,
"Descricao":"Assistência residencial completa",
"HasDetalhe":true,
"Detalhe":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
},
{
"Id":2,
"Descricao":"Rede de Assistência e Serviços 24h",
"HasDetalhe":false,
"Detalhe":""
},
{
"Id":3,
"Descricao":"Sorteio Mensal de R$15.500,00",
"HasDetalhe":false,
"Detalhe":""
}
]
},
{
"Id":49,
"Nome":"SEGURO VIDA & TELEMEDICINA - P1",
"TipoValor":1,
"Preco":399.0,
"Ativo":1,
"Compulsorio":0,
"ModoPgto":0,
"ValorIOF":1.50,
"ProLabore":"30%",
"NumApolice":"xxxxxxx-xxxx-xxxxx-xxx",
"LkpSigla":"PLANO-3",
"LkpCobertura":"Seguro de Vida & Saúde",
"Categoria":4,
"ValorSorteio":10000.00,
"IdadeMax":0.00,
"IdadeMin":0.00,
"ValorMinimo":0.00,
"ValorMaximo":0.00,
"Descricao":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"DescricaoCobertura":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"MaxParcelas":12,
"MinParcelas":02,
"Parcelas":12,
"ListaCobertura": [
{
"Id":1,
"Descricao":"Assistência residencial completa",
"HasDetalhe":true,
"Detalhe":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
},
{
"Id":2,
"Descricao":"Rede de Assistência e Serviços 24h",
"HasDetalhe":false,
"Detalhe":""
},
{
"Id":3,
"Descricao":"Sorteio Mensal de R$15.500,00",
"HasDetalhe":false,
"Detalhe":""
}
]
},
]
Código HTTP da Requisição: 200
Caso não seja possivel localizar a lista de seguros, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Desculpe, mas não foi possível localizar uma categoria para o Id: xx"
}
Código HTTP da Requisição: 400
O endpoint Atualizar Cadastro do Segurado, serve para atualizar o cadastro de um cliente que deseja realizar a solicitação de um seguro. Algumas informações para a solicitação do seguro são obrigatórias, por tanto deverão ser informadas no corpo desta requisição.
Detalhamento dos campos a serem enviados no body da requisição:
| Nome | Tipo | Obrigatório |
|---|---|---|
| Nome | String | SIM |
| CPF | String | SIM |
| Telefone | String | SIM |
String | SIM | |
| DataNasc | DateTime | SIM |
| Sexo | Int | SIM |
| Renda | Numeric | SIM |
| EstadoCivil | Int | SIM |
| TipoProfissao | Int | SIM |
Segue a relação dos códigos para o campo Sexo:
| Codigo | Descrição |
|---|---|
| 1 | MASCULINO |
| 2 | FEMININO |
| 3 | OUTRO(S) |
Segue a relação dos códigos para o campo TipoProfissao:
| Codigo | Descrição |
|---|---|
| 1 | Empreendedor/Prospecto |
| 2 | Funcionário do Empreendedor |
| 3 | Conjuge/Filho do Empreedendor |
| 4 | Funcionário Público |
| 5 | Funcionário Privado |
| 6 | Empreendedor com Renda Comprovada |
Segue a relação dos códigos para o campo EstadoCivil:
| Codigo | Descrição |
|---|---|
| 1 | Amigado(a) |
| 2 | Casado(a) |
| 3 | Divorciado(a) |
| 4 | Separado(a) |
| 5 | Solteiro(a) |
| 6 | Viúvo(a) |
Segue abaixo um exemplo do JSON a ser enviado na requisição
{
"Cpf" : "512.236.349-81",
"Nome" : "Vinicius Geraldo Gael Drumond",
"Email" : "[email protected]",
"Telefone" : "(86) 9 8239-7084",
"DataNasc" : "1990-01-08T00:00:00",
"Sexo" : 1,
"TipoProfissao" : 4,
"EstadoCivil" : 1,
"Renda" : 8000.0
}
Em caso de sucesso a API Ceape Brasil retornará um JSON semelhante ao descrito no exemplo abaixo.
{
"Id":5000,
"CryptKey":"XXXXXXXXX",
"Nome":"EDEM FERNANDO BASTOS CASTRO",
"Cpf":"XXX.XXX.XXX-XX",
"NumeroRG":"XXXXXXXXX",
"NomeMae":"FULANO DE TAL",
"Email":"[email protected]",
"Telefone":"(99) 9 9999-9999",
"Apelido":"ECASTRO",
"DataNasc":"2000-11-28T00:00:00",
"FaixaRenda":6,
"Profissao":"Professor",
"PPE":2,
"CnpjEmpresa":"XX.XXX.XXX/XXXX-XX",
"Sexo":1,
"Renda":1000.00,
"TipoProfissao":5,
"EstadoCivil":4,
"CategoriaTaxa":0,
"CategoriaCliente":"SemCategoria",
"Uf":"MA",
"Cep":"XX.XXX-XXX",
"Cidade":211130,
"Bairro":"JARDIM AMÉRICA",
"Endereco":"Alameda Ever Green",
"EnderecoNumero":"nº 17",
"Complemento":"Lorem ipsum...",
"Banco":332,
"Agencia":"0001",
"AgenciaDv":"",
"TipoConta":2,
"Conta":"xxxxxxxxxxx",
"ContaDv":"x",
"LkpSexo":"MASCULINO",
"LkpTipoProfissao":"Funcionário Privado",
"LkpEstadoCivil":"Separado(a)",
"LkpFaixaRenda":"De R$ 10.000,00 a R$ 20.000,00",
"LkpPPE":"Não sou e não tenho vínculo com pessoa exposta politicamente"
}
Código HTTP da Requisição: 200
Caso não seja possivel atualizar o cadastro, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"A sua solicitação de cadastro falhou no Ceape Brasil por causa dos seguintes motivos: - Telefone incompleto\r\n - E-mail inválido\r\n - Data de nascimento incompleta\r\n - Sexo inválido\r\n - Estado Civíl inválido\r\n - Tipo Profissão inválida\r\n - Renda inválida\r\n"
}
Código HTTP da Requisição: 400
O endpoint Adicionar Endereço do Cliente, irá adicionar um endereço ao cadastro do cliente.
Detalhamento dos campos a serem enviados no body da requisição:
| Nome | Tipo | Obrigatório |
|---|---|---|
| Uf | String | SIM |
| Cep | String | SIM |
| Cidade | Int | SIM |
| Bairro | String | SIM |
| Endereco | String | SIM |
| Numero | String | SIM |
| IsSafe | Boolean | SIM |
| Complemento | String | NÃO |
Atenção: caso o endereço seja referente a solicitação de um seguro de imóvel, o campo IsSafe deverá ser informado como true. Caso contrário deverá ser informado como false.
Segue abaixo um exemplo do JSON a ser enviado na requisição
{
"Uf":"SP",
"Cep":"xxxxx-xxx",
"Cidade":355030,
"Bairro":"JARDIM GUARAU",
"Endereco":"Rua Caraucá",
"Numero":"698",
"IsSafe":true,
"Complemento":"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been"
}
Em caso de sucesso a API Ceape Brasil retornará um JSON semelhante ao descrito no exemplo abaixo.
{
"Uf":"SP",
"Cep":"xxxxx-xxx",
"Cidade":355030,
"Bairro":"JARDIM GUARAU",
"Endereco":"Rua Caraucá",
"Numero":"698",
"IsSafe":true,
"Complemento":"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been"
}
Código HTTP da Requisição: 200
Caso não seja possivel adicionar o endereço, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Message":"Cidade não localizada"
}
{
"Message":" - UF informada inválida\r\n - Cidade informada inválida\r\n - Bairro informado inválido\r\n - Endereço informado inválido\r\n - CEP informado inválido\r\n"
}
Código HTTP da Requisição: 400
O Endpoint Obter Dependentes Ativos retorna uma lista de dependentes ativos do cadastro de um cliente do Ceape Brasil. Para isso você deverá informar os campos do cliente: costumer, document e cryptKey na URL da requisição
Atenção para o campo Parentesco retornado no json, segue a lista de código para o mesmo:
Segue a relação dos Códigos para o campo Parentesco
| Código | Descricao |
|---|---|
| 1 | Pais |
| 2 | Avós |
| 3 | Bisavós |
| 4 | Trisavós |
| 5 | Filhos(as) |
| 6 | Netos(as) |
| 7 | Bisnetos(as) |
| 8 | Trineto(a) |
| 9 | Cônjuge |
Em caso de sucesso a API Ceape Brasil retornará um JSON semelhante ao descrito no exemplo abaixo.
[
{
"Costumer":20001,
"Id":1,
"Nome":"Victor Mário Marcos Barros",
"Cpf":"633.119.602-11",
"Parentesco":5,
"Percentual":0,
"DataNasc":"1999-01-16T00:00:00",
"LkpParentesco":"Filhos(as)"
},
{
"Costumer":20002,
"Id":2,
"Nome":"Victor Mário Marcos Barros",
"Cpf":"633.119.602-11",
"Parentesco":5,
"Percentual":0,
"DataNasc":"1999-01-16T00:00:00",
"LkpParentesco":"Filhos(as)"
},
{
"Costumer":20003,
"Id":3,
"Nome":"Victor Mário Marcos Barros",
"Cpf":"633.119.602-11",
"Parentesco":5,
"Percentual":0,
"DataNasc":"1999-01-16T00:00:00",
"LkpParentesco":"Filhos(as)"
},
]
Código HTTP da Requisição: 200
Em caso de falha, a API do Ceape Brasil retornará um JSON semelhante ao exemplo abaixo:
{
"Message":"Desculpe mas não foi possível processar a sua requisição."
}
Código HTTP da Requisição: 400
O Endpoint Obter Meus Seguros retorna uma lista de seguros ativos solicitado pelo cliente no Ceape Brasil. Para isso você deverá informar os campos do cliente: costumer e cryptKey na URL da requisição
Em caso de sucesso a API Ceape Brasil retornará um JSON semelhante ao descrito no exemplo abaixo.
[
{
"Id":181370000008,
"LkpProduto":"SEGURO VIDA & TELEMEDICINA - P1",
"LkpCategoria":"Seguro de Vida & Saúde",
"ValorSeguro":399.90,
"Status":1,
"LkpStatus":"Solicitado",
"Data":"2023-02-07T00:00:00",
"UrlCertificado":"",
"UrlProposta":"",
},
{
"Id":181370000008,
"LkpProduto":"SEGURO VIDA & TELEMEDICINA - P1",
"LkpCategoria":"Seguro de Vida & Saúde",
"ValorSeguro":399.90,
"Status":1,
"LkpStatus":"Solicitado",
"Data":"2023-02-07T00:00:00",
"UrlCertificado":"",
"UrlProposta":"",
},
]
Código HTTP da Requisição: 200
Caso não seja possivel localizar os dependentes, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Não foi possível localizar a lista de seguros ativos para o cliente com Id: xxxxxx"
}
Código HTTP da Requisição: 400
O Endpoint Obter Seguro retorna uma solicitação de seguro pelo cliente no Ceape Brasil. Para isso você deverá informar os campos: insurance_id, costumer_id e cryptKey na URL da requisição
Em caso de sucesso a API Ceape Brasil retornará um JSON semelhante ao descrito no exemplo abaixo.
{
"Id":181370000008,
"LkpProduto":"SEGURO VIDA & TELEMEDICINA - P1",
"LkpCategoria":"Seguro de Vida & Saúde",
"ValorSeguro":399.90,
"Status":1,
"LkpStatus":"Solicitado",
"Data":"2023-02-07T00:00:00",
"UrlCertificado":"",
"UrlProposta":"",
"ListaDependentes": [
{
"Costumer":xxxxxx,
"Id":1,
"Nome":"NOME DO BENEFICIÁRIO",
"Cpf":"xxx.xxx.xxx-xx",
"Parentesco":5,
"Percentual":20.00,
"DataNasc":"2005-04-09T00:00:00",
"LkpParentesco":"Filhos(as)"
}
],
"ObjSeguro": {
"Id":49,
"Nome":"SEGURO VIDA & TELEMEDICINA - P1",
"TipoValor":1,
"Preco":399.0,
"Ativo":1,
"Compulsorio":0,
"ModoPgto":0,
"ValorIOF":1.50,
"ProLabore":"30%",
"NumApolice":"xxxxxxx-xxxx-xxxxx-xxx",
"LkpSigla":"PLANO-1",
"Categoria":4,
"ValorSorteio":10000.00,
"IdadeMax":0.00,
"IdadeMin":0.00,
"ValorMinimo":0.00,
"ValorMaximo":0.00,
"Descricao":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"DescricaoCobertura":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"MaxParcelas":12,
"MinParcelas":2,
"Parcelas":12,
"ListaCobertura": [
{
"Id":1,
"Descricao":"Assistência residencial completa",
"HasDetalhe":true,
"Detalhe":"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
]
},
"ObjCategoria": {
"Id":20,
"Nome":"Seguro de Vida & Saúde",
"Descricao":"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been",
"Status":1,
"UrlBanner":"https://api.ceapebrasil.org.br/Images/url-banner.jpg",
"UrlIcone":"https://api.ceapebrasil.org.br/Images/url-banner.jpg",
"ListaSeguros": []
}
}
Código HTTP da Requisição: 200
Caso não seja possivel localizar os dependentes, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Não foi possível localizar o pedido pelo id: xxxxxx"
}
Código HTTP da Requisição: 400
O Endpoint Contratar Seguro realiza a solicitação de uma contratação de um microsseguro do Ceape Brasil.
Detalhamento dos campos a serem enviados no body da requisição:
| Nome | Tipo | Obrigatório |
|---|---|---|
| Costumer | Int | SIM |
| Seguro | Int | SIM |
| ListaDependentes | ArrayList | NÃO |
Segue a descrição dos campos enviados na solicitação
| Campo | Descrição |
|---|---|
| Costumer | Código do cliente no banco de dados do Ceape Brasil, correspondente ao campo costumer_id. |
| Seguro | Código do produto de microsseguro no banco de dados do Ceape Brasil, corresponde ao campo Id retornado do Endpoint Obter Lista de Produtos Ativos |
| ListaDependentes | Lista de dependentes que serão os beneficiários da solicitação de seguro. Cada item da lista deve estar no formato do objeto descrito abaixo |
Detalhamento dos campos dos items da lista ListaDependentes
| Nome | Tipo | Obrigatório |
|---|---|---|
| CPF | String | NÃO |
| Nome | String | SIM |
| DataNasc | DateTime | NÃO |
| Percentual | Double | SIM |
| Parentesco | Int | SIM |
Segue a relação dos Códigos para o campo Parentesco
| Código | Descrição |
|---|---|
| 1 | Pais |
| 2 | Avós |
| 3 | Bisavós |
| 4 | Trisavós |
| 5 | Filhos(as) |
| 6 | Netos(as) |
| 7 | Bisnetos(as) |
| 8 | Trineto(as) |
| 9 | Cônjuge |
Segue abaixo um exemplo do json a ser enviado no body da requisição
{
"Costumer":"xxxxx",
"Seguro":52,
"ListaDependentes":[
{
"Nome":"NOME DO BENEFICIÁRIO: 1",
"Cpf":"xxx.xxx.xxx-xx",
"Parentesco":9,
"Percentual":50,
"DataNasc":"2001-09-05T00:00:00",
},
{
"Nome":"NOME DO BENEFICIÁRIO: 2",
"Cpf":"xxx.xxx.xxx-xx",
"Parentesco":9,
"Percentual":50,
"DataNasc":"2001-09-05T00:00:00",
},
{
"Nome":"NOME DO BENEFICIÁRIO: 3",
"Cpf":"xxx.xxx.xxx-xx",
"Parentesco":9,
"Percentual":50,
"DataNasc":"2001-09-05T00:00:00",
},
]
}
Em Caso de sucesso a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Codigo":9660,
"Data":"20/01/2023",
"TipoServico":13,
"NomeServico":"SOLICITAÇÃO DE SEGURO",
"StatusAtual":0,
"NomeStatus":"",
"NomeAtendente":"Sem Atendente",
"ProcessoAtual":0,
"NomeProcesso":"Atendimento não iniciado",
"Resumo":""
}
Código HTTP da Requisição: 200
Caso não seja possivel realizar a contratação do seguro, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"- O Seguro não foi informado \r\n - O Costumer não foi informado \r\n"
}
Código HTTP da Requisição: 400
{
"Message":"Atenção: a soma do percentual dos dependentes deve ser igual a 100%. O percentual total está em: xx%"
}
Código HTTP da Requisição: 400
{
"Message":Desculpe, mas para solicitar o produto: xxxxxxxxxxxxxxxxxxxxxx o cliente deve ter entre: xx a xx anos de idade. O cliente possui: xx anos de idade!
}
Código HTTP da Requisição: 400
O Endpoint Obter Proposta de Adesão retornará um arquivo PDF correspondente à proposta de adesão de seguro. A visualização deste documento, seguido de um termo de aceite concedido pelo usuário, é obrigatória pra a contratação de um novo seguro.
A API Ceape Brasil retornará o código 200 nos casos de sucesso com o arquivo PDF correspondente à proposta de adesão de seguro no corpo da resposta.
Caso não seja possivel obter a proposta de adesão do seguro, a API Ceape Brasil retornará um JSON com os detalhes do motivo do erro, conforme imagem a seguir:
{
"Message":"A proposta de adesão deste seguro não está num formato válido."
}
Código HTTP da Requisição: 400
O Endpoint Obter Certificado de Seguro retornará um arquivo PDF com o certificado de contratação do seguro em questão. Este documento somente poderá ser disponibilizado aos segurados quando o seguro estiver ativo.
A API Ceape Brasil retornará o código 200 nos casos de sucesso com o arquivo PDF correspondente ao certificado de seguro.
Caso não seja possivel obter o certificado de adesão de um seguro, a API Ceape Brasil retornará um JSON com os detalhes do motivo do erro, conforme imagem a seguir:
{
"Message":"Este seguro ainda não foi ativado. Verifique se existe alguma pendência financeira ou entre em contato com a nossa central de atendimento."
}
Código HTTP da Requisição: 400
O Endpoint Obter Boleto retornará os dados do boleto no formato JSON. Via de regra, uma solicitação de seguro está pendente de ativação enquanto não for realizado o pagamento e posterior liquidação deste boleto (ou qualquer outro meio de pagamento). Com a liquidação do mesmo, o status do seguro é alterado para Ativado.
Após a requisição, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"UidParcela":"00000000000000000000000222222222",
"Boleto":"0225454880884456456486545645645465465465465",
"LinhaDigitavel":"00190000090280029838800055268171189560000024640",
"DataEmissao":"2022-01-20 00:00:00.000",
"DataVencimento":"2022-02-20 00:00:00.000",
"Valor":"199.00",
}
Código HTTP da Requisição: 200
Caso não seja possivel localizar os produtos para o cliente, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
{
"Message":"Identificador da parcela inválida. O id de uma parcela de crédito no Ceape é composto de 24 dígitos."
}
Código HTTP da Requisição: 400
O Endpoint Obter PDF do Boleto retornará arquivo correspondente ao boleto gerado.
A API Ceape Brasil retornará o código 200 nos casos de sucesso com o arquivo PDF correspondente boleto.
Caso não seja possivel obter o certificado de adesão de um seguro, a API Ceape Brasil retornará um JSON com os detalhes do motivo do erro, conforme imagem a seguir:
{
"Message":"Aconteceu uma falha interna na geração do arquivo do boleto."
}
Código HTTP da Requisição: 400