curl -X POST "https://api.sistema-representantes.com.br/api/v1/representadas" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"nome": "Alimentos Naturais LTDA",
"cnpj": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 3456-7890",
"endereco": "Rua Verde, 123",
"cidade": "São Paulo",
"estado": "SP",
"contato": "Pedro Santos",
"observacao": "Especializada em produtos orgânicos",
"comissao": 7.5,
"ativo": true
}'
const representada = {
nome: "Doces & Cia Distribuidora",
cnpj: "98.765.432/0001-10",
email: "[email protected]",
telefone: "(21) 2345-6789",
endereco: "Av. dos Doces, 500",
cidade: "Rio de Janeiro",
estado: "RJ",
contato: "Ana Costa",
observacao: "Fornecedor de doces artesanais e importados",
comissao: 9.0
};
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/representadas', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
},
body: JSON.stringify(representada)
});
const result = await response.json();
if (result.success) {
console.log('Representada criada:', result.data);
console.log('ID:', result.data.id);
} else {
console.error('Erro:', result.error);
}
import requests
import json
url = "https://api.sistema-representantes.com.br/api/v1/representadas"
headers = {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
}
representada = {
"nome": "Frios Premium Distribuidora",
"cnpj": "45.678.901/0001-23",
"email": "[email protected]",
"telefone": "(31) 3456-7890",
"endereco": "Rua do Comércio, 1500",
"cidade": "Belo Horizonte",
"estado": "MG",
"contato": "Carlos Mendes",
"observacao": "Especializada em frios e embutidos premium",
"comissao": 8.0,
"ativo": True
}
response = requests.post(url, headers=headers, json=representada)
result = response.json()
if response.status_code == 201:
print("Representada criada com sucesso!")
print(f"ID: {result['data']['id']}")
print(f"Nome: {result['data']['nome']}")
print(f"Comissão: {result['data']['comissao']}%")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
if 'details' in result:
print("Detalhes:", result['details'])
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174111",
"nome": "Alimentos Naturais LTDA",
"cnpj": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 3456-7890",
"endereco": "Rua Verde, 123",
"cidade": "São Paulo",
"estado": "SP",
"contato": "Pedro Santos",
"observacao": "Especializada em produtos orgânicos",
"comissao": 7.5,
"ativo": true,
"created_at": "2024-01-26T10:00:00Z",
"updated_at": "2024-01-26T10:00:00Z"
}
}
{
"error": "Dados de entrada inválidos",
"details": [
{
"code": "invalid_string",
"validation": "email",
"message": "Invalid email",
"path": ["email"]
}
]
}
{
"error": "API key ausente"
}
Representadas
Criar Representada
Cadastra uma nova representada no sistema
POST
/
api
/
v1
/
representadas
curl -X POST "https://api.sistema-representantes.com.br/api/v1/representadas" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"nome": "Alimentos Naturais LTDA",
"cnpj": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 3456-7890",
"endereco": "Rua Verde, 123",
"cidade": "São Paulo",
"estado": "SP",
"contato": "Pedro Santos",
"observacao": "Especializada em produtos orgânicos",
"comissao": 7.5,
"ativo": true
}'
const representada = {
nome: "Doces & Cia Distribuidora",
cnpj: "98.765.432/0001-10",
email: "[email protected]",
telefone: "(21) 2345-6789",
endereco: "Av. dos Doces, 500",
cidade: "Rio de Janeiro",
estado: "RJ",
contato: "Ana Costa",
observacao: "Fornecedor de doces artesanais e importados",
comissao: 9.0
};
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/representadas', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
},
body: JSON.stringify(representada)
});
const result = await response.json();
if (result.success) {
console.log('Representada criada:', result.data);
console.log('ID:', result.data.id);
} else {
console.error('Erro:', result.error);
}
import requests
import json
url = "https://api.sistema-representantes.com.br/api/v1/representadas"
headers = {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
}
representada = {
"nome": "Frios Premium Distribuidora",
"cnpj": "45.678.901/0001-23",
"email": "[email protected]",
"telefone": "(31) 3456-7890",
"endereco": "Rua do Comércio, 1500",
"cidade": "Belo Horizonte",
"estado": "MG",
"contato": "Carlos Mendes",
"observacao": "Especializada em frios e embutidos premium",
"comissao": 8.0,
"ativo": True
}
response = requests.post(url, headers=headers, json=representada)
result = response.json()
if response.status_code == 201:
print("Representada criada com sucesso!")
print(f"ID: {result['data']['id']}")
print(f"Nome: {result['data']['nome']}")
print(f"Comissão: {result['data']['comissao']}%")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
if 'details' in result:
print("Detalhes:", result['details'])
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174111",
"nome": "Alimentos Naturais LTDA",
"cnpj": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 3456-7890",
"endereco": "Rua Verde, 123",
"cidade": "São Paulo",
"estado": "SP",
"contato": "Pedro Santos",
"observacao": "Especializada em produtos orgânicos",
"comissao": 7.5,
"ativo": true,
"created_at": "2024-01-26T10:00:00Z",
"updated_at": "2024-01-26T10:00:00Z"
}
}
{
"error": "Dados de entrada inválidos",
"details": [
{
"code": "invalid_string",
"validation": "email",
"message": "Invalid email",
"path": ["email"]
}
]
}
{
"error": "API key ausente"
}
O sistema gera automaticamente um ID único (UUID) para cada representada criada.
Você precisa de uma API key válida no header x-api-key para usar este endpoint.
Headers
string
required
application/json
string
required
API key de autenticação
Body
string
required
Nome/Razão social da representadaMínimo de 1 caractere
string
CNPJ da representadaFormato: XX.XXX.XXX/XXXX-XX
string
Email de contatoDeve ser um email válido
string
Telefone de contato
string
Endereço completo da representada
string
Cidade
string
Estado (UF)Exemplo: SP, RJ, MG
string
Nome da pessoa de contato na representada
string
Observações gerais sobre a representada
boolean
default:"true"
Status inicial da representada
true- Representada ativafalse- Representada inativa
curl -X POST "https://api.sistema-representantes.com.br/api/v1/representadas" \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"nome": "Alimentos Naturais LTDA",
"cnpj": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 3456-7890",
"endereco": "Rua Verde, 123",
"cidade": "São Paulo",
"estado": "SP",
"contato": "Pedro Santos",
"observacao": "Especializada em produtos orgânicos",
"comissao": 7.5,
"ativo": true
}'
const representada = {
nome: "Doces & Cia Distribuidora",
cnpj: "98.765.432/0001-10",
email: "[email protected]",
telefone: "(21) 2345-6789",
endereco: "Av. dos Doces, 500",
cidade: "Rio de Janeiro",
estado: "RJ",
contato: "Ana Costa",
observacao: "Fornecedor de doces artesanais e importados",
comissao: 9.0
};
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/representadas', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
},
body: JSON.stringify(representada)
});
const result = await response.json();
if (result.success) {
console.log('Representada criada:', result.data);
console.log('ID:', result.data.id);
} else {
console.error('Erro:', result.error);
}
import requests
import json
url = "https://api.sistema-representantes.com.br/api/v1/representadas"
headers = {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
}
representada = {
"nome": "Frios Premium Distribuidora",
"cnpj": "45.678.901/0001-23",
"email": "[email protected]",
"telefone": "(31) 3456-7890",
"endereco": "Rua do Comércio, 1500",
"cidade": "Belo Horizonte",
"estado": "MG",
"contato": "Carlos Mendes",
"observacao": "Especializada em frios e embutidos premium",
"comissao": 8.0,
"ativo": True
}
response = requests.post(url, headers=headers, json=representada)
result = response.json()
if response.status_code == 201:
print("Representada criada com sucesso!")
print(f"ID: {result['data']['id']}")
print(f"Nome: {result['data']['nome']}")
print(f"Comissão: {result['data']['comissao']}%")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
if 'details' in result:
print("Detalhes:", result['details'])
Response
Sucesso
boolean
Indica se a operação foi bem-sucedida
object
Dados da representada criada
{
"success": true,
"data": {
"id": "123e4567-e89b-12d3-a456-426614174111",
"nome": "Alimentos Naturais LTDA",
"cnpj": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 3456-7890",
"endereco": "Rua Verde, 123",
"cidade": "São Paulo",
"estado": "SP",
"contato": "Pedro Santos",
"observacao": "Especializada em produtos orgânicos",
"comissao": 7.5,
"ativo": true,
"created_at": "2024-01-26T10:00:00Z",
"updated_at": "2024-01-26T10:00:00Z"
}
}
{
"error": "Dados de entrada inválidos",
"details": [
{
"code": "invalid_string",
"validation": "email",
"message": "Invalid email",
"path": ["email"]
}
]
}
{
"error": "API key ausente"
}
Validações
Validações aplicadas:
- Nome deve ter pelo menos 1 caractere
- Email deve ser válido se fornecido
- Comissão deve estar entre 0 e 100
Dicas
Boas práticas:
- Mantenha o CNPJ no formato padrão brasileiro
- Use a comissão padrão que será aplicada nas vendas
- Preencha o campo contato para facilitar a comunicação
- Use o campo observação para informações importantes sobre prazo de pagamento, condições especiais, etc.