Cadastrar pessoas
É possível cadastrar pessoas físicas ou jurídicas. Alguns dados na nossa base de dados obrigatoriamente são únicos, sendo eles:
CPF, CNPJ, E-MAIL
Endpoints
| Método | URL |
|---|---|
| GET | https://{{url}}/cube/api/v3/pessoas/cadastrar |
Exemplo de corpo da requisição
| Chave | Valor |
|---|---|
| nome* | Nome da pessoa ou razão social da empresa |
| nomeSocial | Nome social da pessoa quando pessoa física |
| nomeFantasia | Nome fantasia da empresa quando pessoa jurídica |
| dataNascimento | Data de nascimento da pessoa |
| email* | E-mail da pessoa |
| nomeMae | Nome da mãe da pessoa |
| rg | Número do RG |
| cpf** | Número do CPF quando pessoa física |
| cnpj** | Número do CNPJ quando pessoa jurídica |
| inscricaoEstadual | Número da inscrição estadual quando pessoa jurídica |
| tipoPessoa* | FISICA ou JURIDICA |
| cep | CEP do endereço, sem traços e pontos (exemplo 01415000) |
| logradouro | Nome do Logradouro |
| complemento | Complemento do Logradouro |
| pontoReferencia | Ponto de referência |
| bairro | Bairro |
| cidade | Cidade |
| uf | Estado |
| numeroLogradouro | Número do logradouro |
| idExterno | ID do sistema externo quando aplicável |
| telefones | Lista de telefones (array) |
| telefone.ddd | DDD (Apenas números) |
| telefone.numero | Número do telefone |
| telefone.ramal | Número do ramal |
| telefone.preferencial | Booleano (true ou false), se é o telefone preferencial para contato |
Exemplo de json de pessoa física
{
"nome": "Yamada Taro",
"dataNascimento": "06/06/1966",
"email": "yamada@mycompany.com",
"nomeMae": "Yamada Hanako",
"rg": "112223332",
"cpf": "111.222.333-45",
"tipoPessoa": "FISICA",
"cep": "01415000",
"logradouro": "Rua pela cintra",
"complemento": "CJ51",
"pontoReferencia": "Ed. Rizkalla Jorge",
"bairro": "Bela vista",
"cidade": "Sao paulo",
"uf": "SP",
"numeroLogradouro": "1149",
"telefones": [
{
"tipo": "COMERCIAL",
"ddd": "11",
"numero": "4890242",
"ramal": "1",
"preferencial": true
}
],
"nomeSocial": "Tanaka",
"idExterno": "1A2B3C4D5E"
}
tip
Os campos marcados com * são obrigatórios.
Respostas
| Status | Descrição |
|---|---|
| 200 | OK - Retorna os dados da pessoa pesquisada |
| 500 | Erro - Falha ao criar a pessoa |
Exemplo de resposta
{
"success": "true",
"idPessoa": 1
}
Permissões necessárias
| Permissão | Descrição |
|---|---|
| seguranca:pessoas:cadastrar | Permite a o cadastro de pessoas no CUBE |