Início > Pessoa fisica
Versão: 2.0
Pessoa física
Última Atualização: 24/02/2025
A API de Pessoa Física permite a gestão de clientes cadastrados no sistema. Disponibiliza endpoints para listar, cadastrar, atualizar e remover registros de clientes. O método GET retorna os clientes cadastrados, o POST permite a inclusão de novos registros, o PATCH possibilita a atualização parcial dos dados e o DELETE remove uma lista de clientes específicos.
GET Pessoa física
Última Atualização: 24/02/2025
Retorna a lista de clientes cadastrados no sistema. Pode incluir filtros opcionais para refinar a busca.
Endpoint GET
Parâmetros da requisição
status: String
Ex: "ativo" ou "inativo"
cpf: String
Ex: "65793397728"
pagina: Integer
Ex: 1
por_pagina: Integer
Ex: 50
Sintaxe da resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Elementos da Resposta
detail
Detalhe da requisição
Tipo: JSON
success
True ou False
Tipo: Bool
message
Mensagem detalhada do sucesso ou falha
Tipo: String
data
Dados do response
Tipo: Array de JSON
id
id do cliente na base Yandeh
Tipo: Integer
nome
Nome completo do cliente
Tipo: String.
email valido do cliente
Tipo: String.
cpf
CPF do cliente com 11 digitos
Tipo: String.
status
Status do cliente, "ativo" ou "inativo"
Tipo: String.
cep
CEP do cliente
Tipo: String.
cidade
Cidade do cliente
Tipo: String.
bairro
Bairro do cliente
Tipo: String.
endereco
Endereço do cliente
Tipo: String.
numero
Número do cliente
Tipo: String.
complemento
Complemento do endereço do cliente
Tipo: String.
latitude
Latitude do endereço do cliente
Tipo: String.
longitude
Longitude do endereço do cliente
Tipo: String.
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
apt-cache showpkg forticlient
POST Pessoa física
Última Atualização: 27/11/2024
Este endpoint tem o papel de cadastrar novos clientes no sistema.
Endpoint POST
Sintaxe da Requisição
Para que a requisição do método PATCH seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da requisição
nome*
Nome da pessoa fisica.
Tipo: String.
Ex: "Abastece Shop"
email*
Email.
Tipo: String.
Ex: "emailexemplo@exemplo.com"
cpf*
CPF da pessoa física.
Tipo: String.
Ex:"65793397728"
cep*
Tipo: String.
Ex: "79000000"
cidade*
Nome da cidade do endereço.
Tipo: String.
Ex: "São Paulo"
bairro*
Nome do bairro.
Tipo: String.
Ex: "Jaraguá"
endereco*
Tipo: String.
Nome do logradouro.
Ex: "Rua Exemplo"
numero*
Numero residencial.
Tipo: String.
Ex: "123 A"
complemento
Complemento da localização.
Tipo: String.
Ex: "Fachada laranja"
latitude*
Latitude geográfica.
Tipo: String.
Ex: "-23.5489"
longitude*
Longitude geográfica.
Tipo: String.
Ex: "-46.6388"
Número CEP do endereço.
Sintaxe da resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Caso ocorra algum erro entre os registros retorna o status code 207, essa será a resposta que você receberá:
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
PATCH Pessoa física
Última Atualização: 27/02/2025
Sintaxe da Requisição
Para que a requisição do método PATCH seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da requisição
É necessário fornecer um JSON com os dados da requisição. Este método permite que o cliente desejado seja atualizado.
nome
Nome da pessoa fisica.
Tipo: String.
Ex: "Abastece Shop"
Email.
Tipo: String.
Ex: "emailexemplo@exemplo.com"
cep
Número CEP do endereço.
Tipo: String.
Ex: "79000000"
cidade
Nome da cidade.
Tipo: String.
Ex: "São Paulo"
bairro
Nome do bairro.
Tipo: String.
Ex: "Jaraguá"
endereco
Tipo: String.
Nome do logradouro.
Ex: "Rua Exemplo"
numero
Numero residencial.
Tipo: String.
Ex: "123 A"
complemento
Complemento da localização.
Tipo: String.
Ex: "Fachada laranja"
latitude
Latitude geográfica.
Tipo: String.
Ex: "-23.5489"
longitude
Longitude geográfica.
Tipo: String.
Ex: "-46.6388"
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
Este endpoint tem o papel de atualizar pessoas físicas que já estão cadastradas.
Endpoint PATCH
POST Deletar pessoa física
Última atualização: 27/02/2025
Este endpoint tem o papel de deletar permanentemente pessoas físicas na base de dados.
Endpoint POST
Sintaxe da Requisição
Para que a requisição do método Delete seja bem-sucedida, é necessário que
seja passado os seguintes valores dentro de um JSON:
Elementos da Requisição
clientesParaExclusao
Lista de clientes que serão excluidos
Tipo: JSON.
cpfs
CPFs que serão deletados.
Tipo: Array de String.
Sintaxe da Resposta
Caso ocorra tudo certo com a requisição e retorne o status code 200, essa será a resposta que você receberá:
Respostas para erros
Caso ocorra algum erro durante a requisição, os possíveis erros são:
422 Validation Error
Existem também respostas com status code 207 para exclusões parciais:
Resposta para clientes não encontrados com status code 204: