Para cadastrar uma pessoa física precisaremos primeiramente de seu CPF.
Este valor de documento será o "doc" que iremos enviar para a API
Nossa API só irá aceitar valores de "doc" possuindo 11 ou 14 números, representando CPF e CNPJ respectivamente.
Caso seja enviado um valor com um valor diferente de 11 ou 14 números a API não irá realizar o cadastro.
Campos obrigatórios
“nome”
“status”
“data_nascimento”
“doc”
“estado_civil”
“grau_instrucao”
“nome_fantasia”
“forma_juridica”
“armazem_gerenciado”
“classificacao”
“tipo_endereco”
“tipo_logradouro”
“cep_endereco”
“endereco”
“num_endereco”
“bairro_endereco”
“cidade_endereco”
“estado_endereco”
“pais_endereco”
“tipo_telefone”
“ddd_telefone”
“telefone”
“nome_contato”
“grau_relacionamento”
Com o CPF e os dados cadastrais obrigatórios podemos enviar estas informações para a API para que seja realizado o cadastro desta pessoa no GTI Plug.
Quando o campo “doc” possuir 11 caracteres válidos (ou seja, é um CPF), os campos abaixo não precisam ser enviados e serão ignorados, pois este são relativos à Pessoas Jurídicas.
“nome_fantasia”
“forma_juridica”,
“porte_empresa”
“data_constituicao”
“data_registro”
“inscricao_municipal”
“data_alteracao_contratual”
“capital_social”
“capital_integralizado”
“patrimonio_liquido”
“receita_bruta”
“numero_filiais”
“crc_responsavel”
"armazem_gerenciado"
Enviar os dados da pessoa
http://host_name:port/v1/{tenant_id}/pessoa/cadastro/doc/{id}
O "doc" será o valor do documenta da pessoa a ser cadastrada.
{
“dados_pessoa”: [
{
“doc”: “integer”,
“idExterno” : "string",
“status”: "integer",
“nome”: "string",
“data_nascimento”: "string",
“num_identidade”: “string”,
“orgao_expedidor” : “integer”,
“estado_civil”: "integer",
“grau_instrucao”: "integer",
“nome_fantasia”: "string",
“forma_juridica”: "integer",
“classificacao”: "integer",
“nome_pai” : "string",
“nome_mae” : "string",
“email” : "string",
“site” : "string",
“porte_empresa” : "integer",
“data_constituicao” : "string",
“data_registro” : "string",
“inscricao_municipal” : "string",
“data_alteracao_contratual” : "string",
“capital_social” : "integer",
“capital_integralizado” : "integer",
“patrimonio_liquido” : "integer",
“receita_bruta” : "integer",
“numero_filiais” : "integer",
“crc_responsavel” : "string",
“armazem_gerenciado”: “boolean”,
}
]
“dados_endereco”: [
{
“tipo_endereco” : "integer",
“cep_endereco” : "string",
“tipo_logradouro” : "integer",
“endereco” : "string",
“num_endereco” : "integer",
“complemento_endereço” : "string",
“bairro_endereco” : "string",
“cidade_endereco” : "string",
“estado_endereco” : "string",
“pais_endereco” : "string",
“zona_urbana” : "boolean",
“modalidade_ocupacao” : "iteger",
}
]
“dados_telefone”: [
{
“tipo_telefone” : "integer",
“ddd_telefone” : "integer",
“telefone” : "integer",
}
]
“dados_contato”: [
{
“nome_contato” : "string",
“grau_relacionamento” : "string",
}
]
}
{
"dados_pessoa": [
{
"doc": 10393389090,
"idExterno": "003568",
"status": 2,
"nome": "Teste Especificacao da Silva",
“data_nascimento”: "2020-10-05",
“num_identidade”: “18164266”,
“orgao_expedidor” : 4,
“estado_civil”: 1,
“grau_instrucao”: 5,
"classificacao": 6,
“nome_pai” : "Pai do Teste",
“nome_mae” : "Mãe do Teste",
"email": "[email protected]",
"site": "www.cabtec.com.br",
}
],
"dados_endereco": [
{
"tipo_endereco": 12,
"tipo_logradouro": 34,
"cep_endereco": 30140061,
"endereco": "dos Timbiras",
"num_endereco": 1754,
"complemento_endereco": "10 Andar",
"bairro_endereco": "Funcionários",
"cidade_endereco": "Belo Horioznte",
"estado_endereco": "MINAS GERAIS",
"pais_endereco": "Brasil",
"zona_urbana": 1,
"modalidade_ocupacao": 1
}
],
"dados_telefone": [
{
"tipo_telefone": 2,
"ddd_telefone": 31,
"telefone": 21259000
}
],
"dados_contato": [
{
"nome_contato": "Fulano da Silva",
"grau_relacionamento": "Diretor de TI"
}
]
}
O retorno será:
{
"dados_pessoa": [
{
"doc": 10393389090,
"idExterno": "003568",
"status": "Ativo",
"nome": "Teste Especificacao da Silva",
“data_nascimento”: "2020-10-05",
“num_identidade”: “18164266”,
“orgao_expedidor” : “Secretaria de Segurança Pública”,
“estado_civil”: "Solteiro",
“grau_instrucao”: "Superior Completo",
"classificacao": Separador,
“nome_pai” : "Pai do Teste",
“nome_mae” : "Mãe do Teste",
"email": "[email protected]",
"site": "www.cabtec.com.br",
}
],
"dados_endereco": [
{
"tipo_endereco": "Residencial”,
"tipo_logradouro": "Rua”,
"cep_endereco": 30140061,
"endereco": "dos Timbiras",
"num_endereco": 1754,
"complemento_endereco": "10 Andar",
"bairro_endereco": "Funcionários",
"cidade_endereco": "Belo Horioznte",
"estado_endereco": "MINAS GERAIS",
"pais_endereco": "Brasil",
"zona_urbana": "Sim”,
"modalidade_ocupacao": "Própria”
}
],
"dados_telefone": [
{
"tipo_telefone": "Fixo Comercial”,
"ddd_telefone": 31,
"telefone": 21259000
}
],
"dados_contato": [
{
"nome_contato": "Fulano da Silva",
"grau_relacionamento": "Diretor de TI"}
]
}
Alterar o cadastro de uma Pessoa Física
http://host_name:port/v1/{tenant_id}/pessoa/alteracao/doc/{id}
Para realizarmos uma alteração em uma pessoa já cadastrada precisaremos de seu número de documento e informar quais campos devem ser alterados.
Diferente do cadastro, ao atualizarmos um cadastro não existe a necessidade de enviar todos os campos obrigatórios.
Devemos apenas informar quais informações da pessoa desejamos alterar.
{
"dados_pessoa": [
{
"grau_instrucao": 6,
"estado_civil": 5,
}
],
"dados_endereco": [],
"dados_telefone": [
{
"tipo_telefone": 1,
"ddd_telefone": 31,
"telefone": 21259047
}
],
"dados_contato": []
}
O retorno será:
{
"dados_pessoa": [
{
"doc": 10393389090,
"idExterno": "003568",
"status": "Ativo",
"nome": "Teste Especificacao da Silva",
“data_nascimento”: "2020-10-05",
“num_identidade”: “18164266”,
“orgao_expedidor” : “Secretaria de Segurança Pública”,
“estado_civil”: "Casado(a)",
“grau_instrucao”: "Pós-Graduado",
"classificacao": Separador,
“nome_pai” : "Pai do Teste",
“nome_mae” : "Mãe do Teste",
"email": "[email protected]",
"site": "www.cabtec.com.br",
}
],
"dados_endereco": [
{
"tipo_endereco": "Residencial”,
"tipo_logradouro": "Rua”,
"cep_endereco": 30140061,
"endereco": "dos Timbiras",
"num_endereco": 1754,
"complemento_endereco": "10 Andar",
"bairro_endereco": "Funcionários",
"cidade_endereco": "Belo Horioznte",
"estado_endereco": "MINAS GERAIS",
"pais_endereco": "Brasil",
"zona_urbana": "Sim”,
"modalidade_ocupacao": "Própria”
}
],
"dados_telefone": [
{
"tipo_telefone": "Fixo Residencial”,
"ddd_telefone": 31,
"telefone": 21259047
}
],
"dados_contato": [
{
"nome_contato": "Fulano da Silva",
"grau_relacionamento": "Diretor de TI"}
]
}