O cadastro de um CNPJ é o primeiro passo na integração de um novo cliente que deseja utilizar a API de Consulta de Crédito da Tecnospeed.
O objetivo deste cadastro é fazer o envio das informações da empresa que irá efetuar as consultas para a SCC Check. Os demais passos da consulta (como buscar informações de negativação de um determinado CPF) só poderão ser feitos após a aprovação do CNPJ e assinatura do contrato.
O fluxo de trabalho neste ponto fica:
- Utilizar esta rota para cadastrar o CNPJ que irá disparar as consultas;
- Aguardar o contato da SCC Check, que será feito para a assinatura do contrato;
- Receber da SCC Check o "login" e a "senha" que serão fornecidos após a assinatura e liberação do contrato. Estas 2 informações serão utilizadas no momento de disparar as consultas (passo que veremos a seguir).
Definição da Requisição
A solicitação é feita através de uma requisição POST. A rota chamada deve ter a seguinte URL:
Homologação:
https://api.consultanegativacao.com.br/v1/homologacao/cadastros
Produção:
https://api.consultanegativacao.com.br/v1/cadastros
Headers
Nome | Descrição | Exemplo |
cnpjSH | CNPJ da Software House | 01001001000113 |
tokenSH | Token da Software House | CdEZhJcQJS9rRdkLnx2Kl67GhAeBx89X2hzgVQ8i |
Body
Exemplo de json a ser enviado no body da requisição (como application/json)
{
"nomeFantasia": "TESTE NOME FANTASIA",
"razaoSocial": "TESTE RAZÃO SOCIAL",
"cnpj": "00111111111111",
"nomeRepresentante": "TESTE REPRESENTANTE",
"cpfRepresentante": "11111111111",
"telefone": "1111111111",
"email": "TESTE@TESTE",
"endereco": "TESTE ENDERECO",
"numeroEndereco": "TESTE",
"complementoEndereco": "TESTE COMPLEMENTO",
"bairro": "TESTE BAIRRO",
"cep": "88888888",
"cidade": "TESTE",
"uf": "PR",
"nomeResponsavelContrato": "TESTE NOME RESP. ASSINATURA",
"telefoneResponsavelContrato": "TESTE TELEFONE RESP. ASSINATURA",
"emailResponsavelContrato": "TESTE_TESTE@TESTE.COM"
}
Definição dos campos referentes ao Cadastro do CNPJ
Campo | Obrigatório | Tamanho | Descrição |
nomeFantasia | Sim | 10 a 200 | Nome da empresa que está sendo cadastrada |
razaoSocial |
Sim | 10 a 200 | Razão social da empresa que está sendo cadastrada |
CNPJ |
Sim | 1 | CNPJ da empresa que está sendo cadastrada. CNPJ será validado. Informar apenas números |
nomeRepresentante |
Sim | 10 a 20 | Nome do Representante Legal da empresa |
cpfRepresentante |
Sim | 11 ou 14 | CPF do Representante Legal da empresa. CPF será validado. Informar apenas números |
telefone |
Sim | 12 | Telefone da empresa |
|
Sim | 10 a 200 | Email para contato. Utilize um formato de email padrão |
endereço |
Sim | 10 a 200 | Endereço da empresa |
numeroEndereco |
Sim | 1 a 10 | Ex.: 123 |
complementoEndereco |
Não | 0 a 200 | Complemento do endereço |
bairro |
Sim | 5 a 200 | Ex: Centro |
cep | Sim | 8 | Utilizar apenas números referentes ao CEP |
cidade |
Sim | 3 a 200 | Cidade na qual a empresa está situada |
uf |
Sim | 2 | Sigla das 26 UFs + DF. Exemplo: PR |
nomeResponsavelContrato |
Sim | 10 a 200 | Nome do responsável que será contactado para a assinatura do contrato |
telefoneResponsavelContrato |
Sim | 10 a 200 | Telefone do responsável que será contactado para a assinatura do contrato |
emailResponsavelContrato |
Sim | 10 a 200 | Email do responsável que será contactado para a assinatura do contrato. Formato de email padrão |
Retornos
Sucesso:
Status code 200:
{
"nomeFantasia": "TESTE_TESTE",
"razaoSocial": "TESTE_TESTE",
"cnpj": "11111111111111",
"nomeRepresentante": "TESTE_TESTE",
"cpfRepresentante": "11111111111",
"telefone": "4432165465",
"email": "TESTE@TESTE",
"endereco": "TESTE_TESTE",
"numeroEndereco": "TESTE",
"complementoEndereco": "TESTE",
"bairro": "TESTE",
"cep": "78888888",
"cidade": "TESTE",
"uf": "PR",
"nomeResponsavelContrato": "TESTE_TESTE",
"telefoneResponsavelContrato": "TESTE_TESTE",
"emailResponsavelContrato": "TESTE_TESTE@TESTE.COM",
"status": "Aguardando validação da entidade."
}
Obs.: Após receber o retorno com a mensagem de sucesso, é necessário aguardar o contato da SCC Check, que irá providenciar a assinatura do contrato e fornecer as senhas necessárias para as consultas.
Erro:
Status code 422:
Exemplo de erro quando um campo obrigatório não for informado:
{
"code": 422,
"message": "Unprocessable Entity",
"errors": [
{
"message": "Campo cnpj é obrigatório",
"internalCode": 4001
}
]
}
Exemplo de erro quando um campo estiver fora do padrão aceito:
{
"code": 422,
"message": "Unprocessable Entity",
"errors": [
{
"message": "Campo email deve ter menos que 10 caracteres",
"internalCode": 4004
}
]
}
Exemplo de erro quando o CNPJ ou CPF é inválido:
{
"code": 422,
"message": "Unprocessable Entity",
"errors": [
{
"message": "cnpj - 14770188000115 é um CPF/CNPJ inválido",
"internalCode": 4001
},
{
"message": "cpfRepresentante - TESTE_TESTE CPF/CNPJ inválido",
"internalCode": 4001
}
]
}
Exemplo de erro quando os headers da requisição não forem informados:
Nos exemplos acima o objeto "errors" irá retornar uma listagem com as mensagens de erro, que serão apresentadas dentro dos campos "message".
Após implementar a rota de cadastro, é hora de trabalhar na implementação das rotas de consulta. Na sequência iremos entender o funcionamento das 2 rotas responsáveis por efetuar as consultas.
Obs.: As consultas são realizadas utilizando os serviços de consulta oferecidos pela SCC Check, parceira da Tecnospeed nas consultas.
Comentários
0 comentário
Por favor, entre para comentar.