curl -X GET "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
if (result.success) {
console.log('Cliente encontrado:', result.data);
} else {
console.error('Erro:', result.error);
}
import requests
url = "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
response = requests.get(url, headers=headers)
result = response.json()
if response.status_code == 200:
print(f"Cliente: {result['data']['nome']}")
print(f"Email: {result['data']['email']}")
print(f"Cidade: {result['data']['cidade']}")
print(f"Status: {'Ativo' if result['data']['ativo'] else 'Inativo'}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"codigo": "CLI-001",
"nome": "Supermercado Central",
"email": "[email protected]",
"telefone": "(11) 3456-7890",
"cnpj_cpf": "12.345.678/0001-90",
"endereco": "Rua Principal, 1000",
"bairro": "Centro",
"cidade": "São Paulo",
"estado": "SP",
"observacao": "Cliente preferencial, prazo de 30 dias",
"ativo": true,
"segunda": true,
"terca": true,
"quarta": true,
"quinta": true,
"sexta": true,
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-01-25T14:30:00Z"
}
}
{
"error": "Cliente não encontrado"
}
{
"error": "API key inválida"
}
Clientes
Buscar Cliente
Busca um cliente específico pelo ID
GET
/
api
/
v1
/
clients
/
{id}
curl -X GET "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
if (result.success) {
console.log('Cliente encontrado:', result.data);
} else {
console.error('Erro:', result.error);
}
import requests
url = "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
response = requests.get(url, headers=headers)
result = response.json()
if response.status_code == 200:
print(f"Cliente: {result['data']['nome']}")
print(f"Email: {result['data']['email']}")
print(f"Cidade: {result['data']['cidade']}")
print(f"Status: {'Ativo' if result['data']['ativo'] else 'Inativo'}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"codigo": "CLI-001",
"nome": "Supermercado Central",
"email": "[email protected]",
"telefone": "(11) 3456-7890",
"cnpj_cpf": "12.345.678/0001-90",
"endereco": "Rua Principal, 1000",
"bairro": "Centro",
"cidade": "São Paulo",
"estado": "SP",
"observacao": "Cliente preferencial, prazo de 30 dias",
"ativo": true,
"segunda": true,
"terca": true,
"quarta": true,
"quinta": true,
"sexta": true,
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-01-25T14:30:00Z"
}
}
{
"error": "Cliente não encontrado"
}
{
"error": "API key inválida"
}
Retorna todos os detalhes de um cliente cadastrado no sistema.
Você precisa de uma API key válida no header x-api-key para usar este endpoint.
Path Parameters
string
required
ID único do cliente (UUID)
Headers
string
required
API key de autenticação
curl -X GET "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
if (result.success) {
console.log('Cliente encontrado:', result.data);
} else {
console.error('Erro:', result.error);
}
import requests
url = "https://api.sistema-representantes.com.br/api/v1/clients/123e4567-e89b-12d3-a456-426614174000"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
response = requests.get(url, headers=headers)
result = response.json()
if response.status_code == 200:
print(f"Cliente: {result['data']['nome']}")
print(f"Email: {result['data']['email']}")
print(f"Cidade: {result['data']['cidade']}")
print(f"Status: {'Ativo' if result['data']['ativo'] else 'Inativo'}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
Response
Sucesso
boolean
Indica se a operação foi bem-sucedida
object
Dados completos do cliente
Show Estrutura do cliente
Show Estrutura do cliente
string
ID único do cliente (UUID)
string
Código do cliente (opcional)
string
Nome completo do cliente
string
Email do cliente
string
Telefone do cliente
string
CNPJ ou CPF do cliente
string
Endereço completo
string
Bairro
string
Cidade
string
Estado (UF)
string
Observações gerais
boolean
Status do cliente (ativo/inativo)
boolean
Atende às segundas-feiras
boolean
Atende às terças-feiras
boolean
Atende às quartas-feiras
boolean
Atende às quintas-feiras
boolean
Atende às sextas-feiras
string
Data de criação
string
Data da última atualização
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174000",
"codigo": "CLI-001",
"nome": "Supermercado Central",
"email": "[email protected]",
"telefone": "(11) 3456-7890",
"cnpj_cpf": "12.345.678/0001-90",
"endereco": "Rua Principal, 1000",
"bairro": "Centro",
"cidade": "São Paulo",
"estado": "SP",
"observacao": "Cliente preferencial, prazo de 30 dias",
"ativo": true,
"segunda": true,
"terca": true,
"quarta": true,
"quinta": true,
"sexta": true,
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-01-25T14:30:00Z"
}
}
{
"error": "Cliente não encontrado"
}
{
"error": "API key inválida"
}