curl -X GET "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
if (result.success) {
console.log('Representada:', result.data.nome);
console.log('Estatísticas:');
console.log(`- Total de vendas: ${result.data.estatisticas.total_vendas}`);
console.log(`- Total de clientes: ${result.data.estatisticas.total_clientes}`);
console.log(`- Valor total vendido: R$ ${result.data.estatisticas.valor_total.toFixed(2)}`);
} else {
console.error('Erro:', result.error);
}
import requests
url = "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
response = requests.get(url, headers=headers)
result = response.json()
if response.status_code == 200:
rep = result['data']
stats = rep['estatisticas']
print(f"Representada: {rep['nome']}")
print(f"CNPJ: {rep['cnpj']}")
print(f"Cidade: {rep['cidade']}/{rep['estado']}")
print(f"Comissão: {rep['comissao']}%")
print("\nEstatísticas de Vendas:")
print(f"- Total de vendas: {stats['total_vendas']}")
print(f"- Clientes atendidos: {stats['total_clientes']}")
print(f"- Valor total: R$ {stats['valor_total']:,.2f}")
if stats['total_vendas'] > 0:
ticket_medio = stats['valor_total'] / stats['total_vendas']
print(f"- Ticket médio: R$ {ticket_medio:,.2f}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
{
"success": true,
"data": {
"id": "987e6543-e89b-12d3-a456-426614174999",
"nome": "Laticínios Exemplo LTDA",
"cnpj": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 3456-7890",
"endereco": "Rua das Indústrias, 500",
"cidade": "São Paulo",
"estado": "SP",
"contato": "João Silva",
"observacao": "Principal fornecedor de queijos e derivados",
"comissao": 8.5,
"ativo": true,
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-01-25T14:30:00Z",
"estatisticas": {
"total_vendas": 150,
"total_clientes": 45,
"valor_total": 125750.50
}
}
}
{
"error": "Representada não encontrada"
}
{
"error": "API key inválida"
}
{
"error": "Erro interno"
}
Representadas
Buscar Representada
Busca uma representada específica pelo ID com estatísticas de vendas
GET
/
api
/
v1
/
representadas
/
{id}
curl -X GET "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
if (result.success) {
console.log('Representada:', result.data.nome);
console.log('Estatísticas:');
console.log(`- Total de vendas: ${result.data.estatisticas.total_vendas}`);
console.log(`- Total de clientes: ${result.data.estatisticas.total_clientes}`);
console.log(`- Valor total vendido: R$ ${result.data.estatisticas.valor_total.toFixed(2)}`);
} else {
console.error('Erro:', result.error);
}
import requests
url = "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
response = requests.get(url, headers=headers)
result = response.json()
if response.status_code == 200:
rep = result['data']
stats = rep['estatisticas']
print(f"Representada: {rep['nome']}")
print(f"CNPJ: {rep['cnpj']}")
print(f"Cidade: {rep['cidade']}/{rep['estado']}")
print(f"Comissão: {rep['comissao']}%")
print("\nEstatísticas de Vendas:")
print(f"- Total de vendas: {stats['total_vendas']}")
print(f"- Clientes atendidos: {stats['total_clientes']}")
print(f"- Valor total: R$ {stats['valor_total']:,.2f}")
if stats['total_vendas'] > 0:
ticket_medio = stats['valor_total'] / stats['total_vendas']
print(f"- Ticket médio: R$ {ticket_medio:,.2f}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
{
"success": true,
"data": {
"id": "987e6543-e89b-12d3-a456-426614174999",
"nome": "Laticínios Exemplo LTDA",
"cnpj": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 3456-7890",
"endereco": "Rua das Indústrias, 500",
"cidade": "São Paulo",
"estado": "SP",
"contato": "João Silva",
"observacao": "Principal fornecedor de queijos e derivados",
"comissao": 8.5,
"ativo": true,
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-01-25T14:30:00Z",
"estatisticas": {
"total_vendas": 150,
"total_clientes": 45,
"valor_total": 125750.50
}
}
}
{
"error": "Representada não encontrada"
}
{
"error": "API key inválida"
}
{
"error": "Erro interno"
}
Este endpoint retorna informações detalhadas da representada incluindo estatísticas de vendas.
Você precisa de uma API key válida no header x-api-key para usar este endpoint.
Path Parameters
string
required
ID único da representada (UUID)
Headers
string
required
API key de autenticação
curl -X GET "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
if (result.success) {
console.log('Representada:', result.data.nome);
console.log('Estatísticas:');
console.log(`- Total de vendas: ${result.data.estatisticas.total_vendas}`);
console.log(`- Total de clientes: ${result.data.estatisticas.total_clientes}`);
console.log(`- Valor total vendido: R$ ${result.data.estatisticas.valor_total.toFixed(2)}`);
} else {
console.error('Erro:', result.error);
}
import requests
url = "https://api.sistema-representantes.com.br/api/v1/representadas/987e6543-e89b-12d3-a456-426614174999"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
response = requests.get(url, headers=headers)
result = response.json()
if response.status_code == 200:
rep = result['data']
stats = rep['estatisticas']
print(f"Representada: {rep['nome']}")
print(f"CNPJ: {rep['cnpj']}")
print(f"Cidade: {rep['cidade']}/{rep['estado']}")
print(f"Comissão: {rep['comissao']}%")
print("\nEstatísticas de Vendas:")
print(f"- Total de vendas: {stats['total_vendas']}")
print(f"- Clientes atendidos: {stats['total_clientes']}")
print(f"- Valor total: R$ {stats['valor_total']:,.2f}")
if stats['total_vendas'] > 0:
ticket_medio = stats['valor_total'] / stats['total_vendas']
print(f"- Ticket médio: R$ {ticket_medio:,.2f}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
Response
Sucesso
boolean
Indica se a operação foi bem-sucedida
object
Dados completos da representada com estatísticas
Show Estrutura da representada
Show Estrutura da representada
string
ID único da representada (UUID)
string
Nome/Razão social
string
CNPJ
string
Email de contato
string
Telefone
string
Endereço completo
string
Cidade
string
Estado (UF)
string
Pessoa de contato
string
Observações
boolean
Status
string
Data de criação
string
Data da última atualização
{
"success": true,
"data": {
"id": "987e6543-e89b-12d3-a456-426614174999",
"nome": "Laticínios Exemplo LTDA",
"cnpj": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 3456-7890",
"endereco": "Rua das Indústrias, 500",
"cidade": "São Paulo",
"estado": "SP",
"contato": "João Silva",
"observacao": "Principal fornecedor de queijos e derivados",
"comissao": 8.5,
"ativo": true,
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-01-25T14:30:00Z",
"estatisticas": {
"total_vendas": 150,
"total_clientes": 45,
"valor_total": 125750.50
}
}
}
{
"error": "Representada não encontrada"
}
{
"error": "API key inválida"
}
{
"error": "Erro interno"
}
Informações Úteis
As estatísticas incluem:
- Total de vendas realizadas para esta representada
- Quantidade de clientes únicos que compraram produtos desta representada
- Valor total acumulado de todas as vendas
- Análise de desempenho
- Cálculo de comissões
- Tomada de decisão sobre parcerias
- Identificação de representadas mais lucrativas