curl -X GET "https://api.sistema-representantes.com.br/api/v1/representadas?page=1&limit=10&ativo=true" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/representadas?search=laticínios', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
if (result.success) {
console.log('Total de representadas:', result.total);
result.data.forEach(rep => {
console.log(`${rep.nome} - ${rep.cidade}/${rep.estado} - Comissão: ${rep.comissao}%`);
});
}
import requests
url = "https://api.sistema-representantes.com.br/api/v1/representadas"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
params = {
'page': 1,
'limit': 50,
'ativo': 'true'
}
response = requests.get(url, headers=headers, params=params)
result = response.json()
if response.status_code == 200:
print(f"Total de representadas ativas: {result['total']}")
for rep in result['data']:
print(f"- {rep['nome']} ({rep['cnpj']})")
print(f" Cidade: {rep['cidade']}/{rep['estado']}")
print(f" Comissão: {rep['comissao']}%")
print()
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"
},
{
"id": "456e7890-e89b-12d3-a456-426614174888",
"nome": "Bebidas Premium Distribuidora",
"cnpj": "98.765.432/0001-10",
"email": "[email protected]",
"telefone": "(21) 2345-6789",
"endereco": "Av. Comercial, 1000",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"contato": "Maria Oliveira",
"observacao": "Especializada em bebidas importadas",
"comissao": 10.0,
"ativo": true,
"created_at": "2024-01-05T11:00:00Z",
"updated_at": "2024-01-20T09:15:00Z"
}
],
"page": 1,
"limit": 10,
"total": 15
}
{
"error": "API key inválida"
}
{
"error": "Erro interno"
}
Representadas
Listar Representadas
Lista todas as representadas cadastradas com paginação
GET
/
api
/
v1
/
representadas
curl -X GET "https://api.sistema-representantes.com.br/api/v1/representadas?page=1&limit=10&ativo=true" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/representadas?search=laticínios', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
if (result.success) {
console.log('Total de representadas:', result.total);
result.data.forEach(rep => {
console.log(`${rep.nome} - ${rep.cidade}/${rep.estado} - Comissão: ${rep.comissao}%`);
});
}
import requests
url = "https://api.sistema-representantes.com.br/api/v1/representadas"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
params = {
'page': 1,
'limit': 50,
'ativo': 'true'
}
response = requests.get(url, headers=headers, params=params)
result = response.json()
if response.status_code == 200:
print(f"Total de representadas ativas: {result['total']}")
for rep in result['data']:
print(f"- {rep['nome']} ({rep['cnpj']})")
print(f" Cidade: {rep['cidade']}/{rep['estado']}")
print(f" Comissão: {rep['comissao']}%")
print()
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"
},
{
"id": "456e7890-e89b-12d3-a456-426614174888",
"nome": "Bebidas Premium Distribuidora",
"cnpj": "98.765.432/0001-10",
"email": "[email protected]",
"telefone": "(21) 2345-6789",
"endereco": "Av. Comercial, 1000",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"contato": "Maria Oliveira",
"observacao": "Especializada em bebidas importadas",
"comissao": 10.0,
"ativo": true,
"created_at": "2024-01-05T11:00:00Z",
"updated_at": "2024-01-20T09:15:00Z"
}
],
"page": 1,
"limit": 10,
"total": 15
}
{
"error": "API key inválida"
}
{
"error": "Erro interno"
}
Use os parâmetros de busca e filtro para encontrar representadas específicas.
Você precisa de uma API key válida no header x-api-key para usar este endpoint.
Headers
string
required
API key de autenticação
Query Parameters
number
default:"1"
Número da página para paginação
number
default:"20"
Quantidade de itens por página (máximo 100)
string
Busca por nome, CNPJ ou cidade da representada
boolean
Filtrar representadas por status
true- Apenas representadas ativasfalse- Apenas representadas inativas- Omitir para listar todas
curl -X GET "https://api.sistema-representantes.com.br/api/v1/representadas?page=1&limit=10&ativo=true" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/representadas?search=laticínios', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
if (result.success) {
console.log('Total de representadas:', result.total);
result.data.forEach(rep => {
console.log(`${rep.nome} - ${rep.cidade}/${rep.estado} - Comissão: ${rep.comissao}%`);
});
}
import requests
url = "https://api.sistema-representantes.com.br/api/v1/representadas"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
params = {
'page': 1,
'limit': 50,
'ativo': 'true'
}
response = requests.get(url, headers=headers, params=params)
result = response.json()
if response.status_code == 200:
print(f"Total de representadas ativas: {result['total']}")
for rep in result['data']:
print(f"- {rep['nome']} ({rep['cnpj']})")
print(f" Cidade: {rep['cidade']}/{rep['estado']}")
print(f" Comissão: {rep['comissao']}%")
print()
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
Response
Sucesso
boolean
Indica se a operação foi bem-sucedida
array
Lista de representadas
Show Estrutura da representada
Show Estrutura da representada
string
ID único da representada (UUID)
string
Nome/Razão social da representada
string
CNPJ da representada
string
Email de contato
string
Telefone de contato
string
Endereço completo
string
Cidade
string
Estado (UF)
string
Nome da pessoa de contato
string
Observações gerais
boolean
Status da representada
string
Data de criação
string
Data da última atualização
number
Página atual
number
Quantidade de itens por página
number
Total de representadas encontradas
{
"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"
},
{
"id": "456e7890-e89b-12d3-a456-426614174888",
"nome": "Bebidas Premium Distribuidora",
"cnpj": "98.765.432/0001-10",
"email": "[email protected]",
"telefone": "(21) 2345-6789",
"endereco": "Av. Comercial, 1000",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"contato": "Maria Oliveira",
"observacao": "Especializada em bebidas importadas",
"comissao": 10.0,
"ativo": true,
"created_at": "2024-01-05T11:00:00Z",
"updated_at": "2024-01-20T09:15:00Z"
}
],
"page": 1,
"limit": 10,
"total": 15
}
{
"error": "API key inválida"
}
{
"error": "Erro interno"
}