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 Resources é 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 com todas as cidades do IBGE cadastradas no nosso banco de dados.
Atenção para o parâmetro {uf}, presente na URL da requisição. Ele será nacessário para obter todas as cidades daquele Estado da União.
Caso sejam localizadas as cidades, a API do Ceape Brasil retornará um JSON semelhante ao abaixo:
[
{
"Codigo":4580,
"Estado":21
"CIDADE":"SÃO LUÍS"
"MercadoPotencial":0,
"UF":"MA"
},
{
"Codigo":4580,
"Estado":21
"CIDADE":"SÃO LUÍS"
"MercadoPotencial":0,
"UF":"MA"
},
{
"Codigo":4580,
"Estado":21
"CIDADE":"SÃO LUÍS"
"MercadoPotencial":0,
"UF":"MA"
},
]
Código HTTP da Requisição: 200
Caso não seja possivel localizar as cidades, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Por favor informe o código UF de um dos Estados da União (MA, SP, GO, RJ...)!"
}
Código HTTP da Requisição: 400
Este Endpoint retorna a lista de Instituições Bancárias que o Ceape Brasil opera.
Caso sejam localizados os bancos, a API Ceape Brasil retornará um JSON semelhante aos exemplos abaixo
[
{
"Codigo":4580,
"Banco":"Nome do Banco",
"Alias":"Apelido do Banco"
},
{
"Codigo":4580,
"Banco":"Nome do Banco",
"Alias":"Apelido do Banco"
},
{
"Codigo":4580,
"Banco":"Nome do Banco",
"Alias":"Apelido do Banco"
},
]
Código HTTP da Requisição: 200
Caso não seja possivel localizar os bancos, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Lista de bancos não encontrada."
}
Código HTTP da Requisição: 400
Este Endpoint retorna a lista de produtos ativos do Ceape Brasil.
Caso sejam localizados os produtos, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
[
{
"Codigo":0,
"Nome":"Nome do Produto",
"Apelido":"Apelido do Produto",
"Data":"2022-05-19T11:18:28.423",
"Modalidade":1,
"Perfil":1,
"MinParcelas":3,
"MaxParcelas":24,
"MinCarencia":20,
"MaxCarencia":60,
"Parcelas":6,
"Carencia":30,
"MinValor":500,
"MaxValor":10100.00,
"TaxaId":0,
"Status":1,
"TxIof":0.38,
"EnumStatus":1,
"EnumModalidade":1,
"EnumPerfil":0,
"LkpStatus":"Ativo",
"LkpTxTaxa":3.5,
"LkpTxTac":3.00,
"Descricao":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"UrlBanner":"https://apisandbox.ceapebrasil.org.br/images/mobile/produto-sanear-sm-icon.png",
"UrlIcone":"https://apisandbox.ceapebrasil.org.br/images/mobile/ic-water-48x48.png"
},
{
"Codigo":1,
"Nome":"Nome do Produto",
"Apelido":"Apelido do Produto",
"Data":"2022-05-19T11:18:28.423",
"Modalidade":1,
"Perfil":1,
"MinParcelas":3,
"MaxParcelas":24,
"MinCarencia":20,
"MaxCarencia":60,
"Parcelas":6,
"Carencia":30,
"MinValor":500,
"MaxValor":10100.00,
"TaxaId":0,
"Status":1,
"TxIof":0.38,
"EnumStatus":1,
"EnumModalidade":1,
"EnumPerfil":0,
"LkpStatus":"Ativo",
"LkpTxTaxa":3.5,
"LkpTxTac":3.00,
"Descricao":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"UrlBanner":"https://apisandbox.ceapebrasil.org.br/images/mobile/produto-sanear-sm-icon.png",
"UrlIcone":"https://apisandbox.ceapebrasil.org.br/images/mobile/ic-water-48x48.png"
},
{
"Codigo":2,
"Nome":"Nome do Produto",
"Apelido":"Apelido do Produto",
"Data":"2022-05-19T11:18:28.423",
"Modalidade":1,
"Perfil":1,
"MinParcelas":3,
"MaxParcelas":24,
"MinCarencia":20,
"MaxCarencia":60,
"Parcelas":6,
"Carencia":30,
"MinValor":500,
"MaxValor":10100.00,
"TaxaId":0,
"Status":1,
"TxIof":0.38,
"EnumStatus":1,
"EnumModalidade":1,
"EnumPerfil":0,
"LkpStatus":"Ativo",
"LkpTxTaxa":3.5,
"LkpTxTac":3.00,
"Descricao":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"UrlBanner":"https://apisandbox.ceapebrasil.org.br/images/mobile/produto-sanear-sm-icon.png",
"UrlIcone":"https://apisandbox.ceapebrasil.org.br/images/mobile/ic-water-48x48.png"
},
]
Código HTTP da Requisição: 200
Caso não seja possivel localizar os produtos, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Lista de produtos não encontrada."
}
Código HTTP da Requisição: 400
Este Endpoint retorna a lista de canais ativos do Ceape Brasil.
Caso sejam localizados os canais, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
[
{
"Codigo":0,
"Nome":"Nome do Canal 0"
},
{
"Codigo":1,
"Nome":"Nome do Canal 1"
},
{
"Codigo":2,
"Nome":"Nome do Canal 2"
},
]
Código HTTP da Requisição: 200
Caso não seja possivel localizar os produtos, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Lista de canais não encontrada."
}
Código HTTP da Requisição: 400
Este Endpoint retorna a um produto informado pelo parâmetro id do Ceape Brasil.
Caso seja possível localizar o produto pelo id informado, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Codigo":202,
"Nome":"Nome do Produto",
"Apelido":"Apelido do Produto",
"Data":"2022-05-19T11:18:28.423",
"Modalidade":1,
"Perfil":1,
"MinParcelas":3,
"MaxParcelas":24,
"MinCarencia":20,
"MaxCarencia":60,
"Parcelas":6,
"Carencia":30,
"MinValor":500,
"MaxValor":10100.00,
"TaxaId":0,
"Status":1,
"TxIof":0.38,
"EnumStatus":1,
"EnumModalidade":1,
"EnumPerfil":0,
"LkpStatus":"Ativo",
"LkpTxTaxa":3.5,
"LkpTxTac":3.00,
"Descricao":"Lorem Ipsum is simply dummy text of the printing and typesetting industry.",
"UrlBanner":"https://apisandbox.ceapebrasil.org.br/images/mobile/produto-sanear-sm-icon.png",
"UrlIcone":"https://apisandbox.ceapebrasil.org.br/images/mobile/ic-water-48x48.png"
}
Código HTTP da Requisição: 200
Caso não seja possivel localizar o produto, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Não foi possível localizar o produto pelo Id: xxx"
}
Código HTTP da Requisição: 400
Este Endpoint irá enviar um token via SMS/WhatsApp á um telefone, este recurso é para casos de confirmação em duas etapas.
Segue abaixo um exemplo do JSON a ser enviado na requisição
Atenção para os campos: application_id e number. Para o primeiro você deverá
informar o seu código na instituição Ceape Brasil (contate o suporte para mais informações), já o segundo deverá ser o número(sem formatação ou máscaras) para o qual você deseja enviar o token: (DDD + Número)
O JSON abaixo é um exemplo de como utilizar o endpoint para enviar o token pelo SMS:
{
"body":{
"application_id":XXXX,
"number":"99999999999",
}
}
O JSON abaixo é um exemplo de como utilizar o endpoint para enviar o token pelo WhatsApp:
{
"body":{
"application_id":XXXX,
"number":"99999999999",
"channel":2,
"template":"Nome do seu template na plataforma Meta"
}
}
(Atenção neste caso o valor para o campo channel deverá sempre ser 2)
Em caso de sucesso, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"data":{
"id":"id.infolight-548330acbe3ad0630864760ca55",
"message":"Token enviado com sucesso",
"verified":false,
},
"errors":null
}
Código HTTP da Requisição: 200
Atenção ao campo id no retorno da requisição, você precisará dele para validar o token posteriormente.
Em caso de erro, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"O campo Número não contém 11 dígitos:(DD + 9 + Número de Celular)"
}
{
"Message":"O campo Número não pode estar vazio!"
}
{
"Message":"O Body da Requisição não foi informado"
}
{
"Message":"O campo application_id não foi informado"
}
{
"Message":"Não foi possível identificar a sua aplição pelo código XXX"
}
Código HTTP da Requisição: 400
Este Endpoint irá enviar confirmar um token que foi enviado ao cliente através do endpoint Enviar Token, este recurso é para casos de confirmação em duas etapas.
Segue abaixo um exemplo do JSON a ser enviado na requisição
Atenção para os campos: id e code. Para o primeiro você deverá
informar o id retornado no Endpoint Enviar Token, já o segundo deverá ser token que o cliente recebeu em seu SMS.
{
"body":{
"application_id":XXXX,
"code":"123456",
"id":"id.infolight-548330acbe3ad0630864760ca55b3093056a38bbe"
}
}
Em caso de sucesso, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"data":{
"id":"id.infolight-548330acbe3ad0630864760ca55",
"message":"Token Validado com Sucesso!",
"verified":true,
},
"errors":null
}
Código HTTP da Requisição: 200
Em caso de erro, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Informe os campos: code, id e application_id"
}
{
"Message":"Não foi possível identificar a sua aplição pelo código xxxx"
}
{
"Message":"Não foi possível localizar o token id.infolight-582798e40af1b1b465d836ec0b3"
}
{
"Message":"O token id.infolight-582798e40af1b1b465d836ec0b3d9e328b55e5aa0666b6e72961b07c582fd685e4c77 não pertence a aplicação xxx"
}
{
"Message":"O Token informado não é válido"
}
{
"Message":"O Token informado já foi validado em: 05/09/2022 10:06:49"
}
Código HTTP da Requisição: 400
Este Endpoint é utilizado para realizar um disparo de SMS pelo Ceape Brasil.
Detalhamento dos campos a serem enviados no body da requisição:
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| To | String | SIM | Campo que serve para indicar qual o contato celular que a mensagem deverá ser enviada. Ex: 5531981141285 |
| StrMessage | String | SIM | Refer-se ao conteúdo da mensagem a ser enviada. |
Segue abaixo um exemplo do JSON a ser enviado na requisição
{
"To":"31981141285",
"StrMessage":"Aqui vai o conteúdo da sua mensagem.",
}
Em caso de sucesso, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Success":true,
"Object":{},
"Message":"A requisicao de envio foi encaminhada para processamento com sucesso.",
}
Código HTTP da Requisição: 200
Em caso de erro, a API Ceape Brasil retornará um JSON semelhante ao exemplo abaixo
{
"Message":"Para enviar um SMS informe os campos 'StrMessage' e 'To'"
}
{
"Message":"Não foi possível enviar o SMS. Por favor verifique os dados."
}
Código HTTP da Requisição: 400