Para facilitar a integração com nossa API, adotamos os códigos de status HTTP como padrão para indicar o resultado das requisições. O código 200 significa que a operação foi concluída com sucesso. Códigos 4xx indicam que você precisa revisar os dados enviados, e códigos 500 sinalizam um problema em nossos servidores.
| Código HTTP | Descrição |
|---|---|
| 200 OK | Requisição bem-sucedida |
| 204 No Content | Requisição bem-sucedida, mas não há conteúdo a ser retornado |
| 400 Bad Request | Requisição mal formada. Verifique parâmetros obrigatórios e seus valores. A resposta detalhada o erro específico |
| 401 Unauthorized | Chave de API ausente ou inválida |
| 403 Forbidden | Requisição não autorizada. Verifique permissões, uso da API e parâmetros |
| 403 Forbidden (Get) | Requisição GET não devem conter corpo (body). Remova o corpo da requisição |
| 404 Not Found | Endpoint ou recuso solicitado não encontrado |
| 409 Conflict | A requisição não pode ser concluída devido a um conflito com o estado atual do recurso |
| 500 Internal Server Error | Erro interno no servidor. Contate o suporte se o problema persistir |
Todos os endpoints da API recebem e respondem em JSON.
Exemplo de resposta para HTTP 200:
{
"Id": "1a744264-61f4-ef11-90cb-6045bd3b4810",
"ClienteId": "1e22b3c2-99d5-ee11-85f9-002248df885e",
"ClienteNome": "Felipe Teste",
"Descricao": "Teste Assinatura 200",
"Valor": 150,
"Periodicidade": "Semanal",
"DiasGeracaoCobranca": 1,
"IniciandoEm": "2025-02-10T00:00:00",
"FinalizandoEm": null,
"FormasPagamento": "Cartao",
"ProdutoId": null,
"Multa": 6,
"JurosMes": 2,
"DescontoAteVencimento": 10,
"SplitValores": null
}
Exemplo de resposta para HTTP 400:
{
"Message": "A solicitação é inválida.",
"ModelState": {
"Assinatura.FormasPagamento": [
"Error converting value \"Cart]ao\" to type 'BknBankCobrancasAPI.Models.CobrancaFormaPagamento'. Path 'FormasPagamento', line 9, position 32."
]
}
}