Padrão de retorno da API
Resumo:
Entenda como interpretar os retornos das requisições realizadas na API FKSmart.
Conteúdo sugerido:
As respostas da API informam se a requisição foi recebida, processada ou rejeitada.
Um retorno de sucesso geralmente indica que os dados foram aceitos para processamento ou concluídos conforme o endpoint utilizado.
Exemplo conceitual:
{
"success": true,
"message": "Documento recebido para processamento",
"protocol": "123456"
}
"success": true,
"message": "Documento recebido para processamento",
"protocol": "123456"
}
Em caso de erro, a resposta pode conter uma mensagem explicando o motivo da rejeição.
Exemplo conceitual:
{
"success": false,
"message": "CNPJ não autorizado para esta integração"
}
"success": false,
"message": "CNPJ não autorizado para esta integração"
}