curl -X POST https://api.sistema-representantes.com.br/api/v1/clients \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"nome": "Supermercado Central",
"email": "[email protected]",
"telefone": "(11) 98765-4321",
"cidade": "São Paulo",
"estado": "SP"
}'
curl -X POST https://api.sistema-representantes.com.br/api/v1/clients \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"nome": "Distribuidora ABC Ltda",
"cnpj_cpf": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(21) 91234-5678",
"endereco": "Av. Industrial, 1000 - Galpão 5",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"codigo": "DIST-ABC-001"
}'
const clientData = {
nome: "Loja do João",
email: "[email protected]",
telefone: "(31) 99876-5432",
cidade: "Belo Horizonte",
estado: "MG",
cnpj_cpf: "123.456.789-10",
endereco: "Rua do Comércio, 100"
};
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/clients', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
},
body: JSON.stringify(clientData)
});
const result = await response.json();
if (result.success) {
console.log(`Cliente criado com ID: ${result.data.id}`);
console.log(`Código gerado: ${result.data.codigo}`);
} else {
console.error('Erro:', result.error);
}
import requests
import json
url = "https://api.sistema-representantes.com.br/api/v1/clients"
headers = {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
}
# Cliente pessoa jurídica
data = {
"nome": "Indústria de Alimentos Silva",
"cnpj_cpf": "98.765.432/0001-10",
"email": "[email protected]",
"telefone": "(41) 93333-4444",
"endereco": "Rod. BR-116, km 95",
"cidade": "Curitiba",
"estado": "PR"
}
response = requests.post(url, headers=headers, json=data)
result = response.json()
if response.status_code == 201:
print(f"Cliente criado com sucesso!")
print(f"ID: {result['data']['id']}")
print(f"Código: {result['data']['codigo']}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
<?php
$url = 'https://api.sistema-representantes.com.br/api/v1/clients';
$headers = [
'Content-Type: application/json',
'x-api-key: sua-api-key-aqui'
];
// Cliente pessoa física
$data = [
'nome' => 'Maria da Silva',
'cpf' => '987.654.321-00',
'email' => '[email protected]',
'telefone' => '(85) 98888-7777',
'endereco' => 'Rua das Palmeiras, 50, Apto 203',
'cidade' => 'Fortaleza',
'estado' => 'CE'
];
$options = [
'http' => [
'header' => implode("\r\n", $headers),
'method' => 'POST',
'content' => json_encode($data)
]
];
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
$response = json_decode($result, true);
if (isset($response['success']) && $response['success']) {
echo "Cliente criado com sucesso!\n";
echo "ID: " . $response['data']['id'] . "\n";
echo "Código: " . $response['data']['codigo'] . "\n";
} else {
echo "Erro: " . $response['error'] . "\n";
}
?>
{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"codigo": "CLI003",
"nome": "Supermercado Central",
"cnpj_cpf": null,
"email": "[email protected]",
"telefone": "(11) 98765-4321",
"endereco": null,
"cidade": "São Paulo",
"estado": "SP",
"ativo": true,
"created_at": "2024-01-20T10:30:00Z",
"updated_at": "2024-01-20T10:30:00Z"
}
}
{
"error": "Dados de entrada inválidos",
"details": {
"nome": "Campo obrigatório",
"email": "Formato de email inválido"
}
}
{
"error": "Email já cadastrado no sistema"
}
{
"error": "API key ausente"
}
{
"error": "Empresa inativa"
}
{
"error": "Estado inválido. Use sigla com 2 letras (ex: SP, RJ)"
}
Clientes
Criar Cliente
Cria um novo cliente no sistema
POST
/
api
/
v1
/
clients
curl -X POST https://api.sistema-representantes.com.br/api/v1/clients \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"nome": "Supermercado Central",
"email": "[email protected]",
"telefone": "(11) 98765-4321",
"cidade": "São Paulo",
"estado": "SP"
}'
curl -X POST https://api.sistema-representantes.com.br/api/v1/clients \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"nome": "Distribuidora ABC Ltda",
"cnpj_cpf": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(21) 91234-5678",
"endereco": "Av. Industrial, 1000 - Galpão 5",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"codigo": "DIST-ABC-001"
}'
const clientData = {
nome: "Loja do João",
email: "[email protected]",
telefone: "(31) 99876-5432",
cidade: "Belo Horizonte",
estado: "MG",
cnpj_cpf: "123.456.789-10",
endereco: "Rua do Comércio, 100"
};
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/clients', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
},
body: JSON.stringify(clientData)
});
const result = await response.json();
if (result.success) {
console.log(`Cliente criado com ID: ${result.data.id}`);
console.log(`Código gerado: ${result.data.codigo}`);
} else {
console.error('Erro:', result.error);
}
import requests
import json
url = "https://api.sistema-representantes.com.br/api/v1/clients"
headers = {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
}
# Cliente pessoa jurídica
data = {
"nome": "Indústria de Alimentos Silva",
"cnpj_cpf": "98.765.432/0001-10",
"email": "[email protected]",
"telefone": "(41) 93333-4444",
"endereco": "Rod. BR-116, km 95",
"cidade": "Curitiba",
"estado": "PR"
}
response = requests.post(url, headers=headers, json=data)
result = response.json()
if response.status_code == 201:
print(f"Cliente criado com sucesso!")
print(f"ID: {result['data']['id']}")
print(f"Código: {result['data']['codigo']}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
<?php
$url = 'https://api.sistema-representantes.com.br/api/v1/clients';
$headers = [
'Content-Type: application/json',
'x-api-key: sua-api-key-aqui'
];
// Cliente pessoa física
$data = [
'nome' => 'Maria da Silva',
'cpf' => '987.654.321-00',
'email' => '[email protected]',
'telefone' => '(85) 98888-7777',
'endereco' => 'Rua das Palmeiras, 50, Apto 203',
'cidade' => 'Fortaleza',
'estado' => 'CE'
];
$options = [
'http' => [
'header' => implode("\r\n", $headers),
'method' => 'POST',
'content' => json_encode($data)
]
];
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
$response = json_decode($result, true);
if (isset($response['success']) && $response['success']) {
echo "Cliente criado com sucesso!\n";
echo "ID: " . $response['data']['id'] . "\n";
echo "Código: " . $response['data']['codigo'] . "\n";
} else {
echo "Erro: " . $response['error'] . "\n";
}
?>
{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"codigo": "CLI003",
"nome": "Supermercado Central",
"cnpj_cpf": null,
"email": "[email protected]",
"telefone": "(11) 98765-4321",
"endereco": null,
"cidade": "São Paulo",
"estado": "SP",
"ativo": true,
"created_at": "2024-01-20T10:30:00Z",
"updated_at": "2024-01-20T10:30:00Z"
}
}
{
"error": "Dados de entrada inválidos",
"details": {
"nome": "Campo obrigatório",
"email": "Formato de email inválido"
}
}
{
"error": "Email já cadastrado no sistema"
}
{
"error": "API key ausente"
}
{
"error": "Empresa inativa"
}
{
"error": "Estado inválido. Use sigla com 2 letras (ex: SP, RJ)"
}
Cadastra um novo cliente com validação automática de dados. O sistema gera automaticamente um código único se não fornecido.
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 ou razão social do clienteMínimo: 3 caracteres
Máximo: 255 caracteres
Máximo: 255 caracteres
string
required
Email do clienteDeve ser um email válido e único no sistema
string
required
Telefone do clienteAceita diversos formatos:
- (11) 98765-4321
- 11987654321
- +5511987654321
string
required
Cidade do cliente
string
required
Estado do cliente (sigla com 2 letras)Exemplos: SP, RJ, MG, RS
string
CNPJ ou CPF do clienteAceita com ou sem formatação:
- CNPJ: 12.345.678/0001-90 ou 12345678000190
- CPF: 123.456.789-10 ou 12345678910
string
Endereço completo do cliente
string
Código personalizado do clienteSe não fornecido, será gerado automaticamente no formato: CLI + número sequencial
boolean
default:"true"
Define se o cliente está ativo
curl -X POST https://api.sistema-representantes.com.br/api/v1/clients \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"nome": "Supermercado Central",
"email": "[email protected]",
"telefone": "(11) 98765-4321",
"cidade": "São Paulo",
"estado": "SP"
}'
curl -X POST https://api.sistema-representantes.com.br/api/v1/clients \
-H "Content-Type: application/json" \
-H "x-api-key: sua-api-key-aqui" \
-d '{
"nome": "Distribuidora ABC Ltda",
"cnpj_cpf": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(21) 91234-5678",
"endereco": "Av. Industrial, 1000 - Galpão 5",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"codigo": "DIST-ABC-001"
}'
const clientData = {
nome: "Loja do João",
email: "[email protected]",
telefone: "(31) 99876-5432",
cidade: "Belo Horizonte",
estado: "MG",
cnpj_cpf: "123.456.789-10",
endereco: "Rua do Comércio, 100"
};
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/clients', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
},
body: JSON.stringify(clientData)
});
const result = await response.json();
if (result.success) {
console.log(`Cliente criado com ID: ${result.data.id}`);
console.log(`Código gerado: ${result.data.codigo}`);
} else {
console.error('Erro:', result.error);
}
import requests
import json
url = "https://api.sistema-representantes.com.br/api/v1/clients"
headers = {
'Content-Type': 'application/json',
'x-api-key': 'sua-api-key-aqui'
}
# Cliente pessoa jurídica
data = {
"nome": "Indústria de Alimentos Silva",
"cnpj_cpf": "98.765.432/0001-10",
"email": "[email protected]",
"telefone": "(41) 93333-4444",
"endereco": "Rod. BR-116, km 95",
"cidade": "Curitiba",
"estado": "PR"
}
response = requests.post(url, headers=headers, json=data)
result = response.json()
if response.status_code == 201:
print(f"Cliente criado com sucesso!")
print(f"ID: {result['data']['id']}")
print(f"Código: {result['data']['codigo']}")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
<?php
$url = 'https://api.sistema-representantes.com.br/api/v1/clients';
$headers = [
'Content-Type: application/json',
'x-api-key: sua-api-key-aqui'
];
// Cliente pessoa física
$data = [
'nome' => 'Maria da Silva',
'cpf' => '987.654.321-00',
'email' => '[email protected]',
'telefone' => '(85) 98888-7777',
'endereco' => 'Rua das Palmeiras, 50, Apto 203',
'cidade' => 'Fortaleza',
'estado' => 'CE'
];
$options = [
'http' => [
'header' => implode("\r\n", $headers),
'method' => 'POST',
'content' => json_encode($data)
]
];
$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
$response = json_decode($result, true);
if (isset($response['success']) && $response['success']) {
echo "Cliente criado com sucesso!\n";
echo "ID: " . $response['data']['id'] . "\n";
echo "Código: " . $response['data']['codigo'] . "\n";
} else {
echo "Erro: " . $response['error'] . "\n";
}
?>
Response
Sucesso
boolean
Indica se a operação foi bem-sucedida
object
Dados do cliente criado
Show Estrutura do cliente
Show Estrutura do cliente
string
ID único do cliente (UUID)
string
Código do cliente (gerado automaticamente se não fornecido)
string
Nome/razão social do cliente
string
CNPJ ou CPF do cliente
string
Email do cliente
string
Telefone do cliente
string
Endereço completo
string
Cidade
string
Estado (sigla)
boolean
Status do cliente
string
Data de criação (ISO 8601)
string
Data da última atualização
Erro
string
Mensagem de erro descritiva
{
"success": true,
"data": {
"id": "550e8400-e29b-41d4-a716-446655440000",
"codigo": "CLI003",
"nome": "Supermercado Central",
"cnpj_cpf": null,
"email": "[email protected]",
"telefone": "(11) 98765-4321",
"endereco": null,
"cidade": "São Paulo",
"estado": "SP",
"ativo": true,
"created_at": "2024-01-20T10:30:00Z",
"updated_at": "2024-01-20T10:30:00Z"
}
}
{
"error": "Dados de entrada inválidos",
"details": {
"nome": "Campo obrigatório",
"email": "Formato de email inválido"
}
}
{
"error": "Email já cadastrado no sistema"
}
{
"error": "API key ausente"
}
{
"error": "Empresa inativa"
}
{
"error": "Estado inválido. Use sigla com 2 letras (ex: SP, RJ)"
}
Validações
O sistema aplica as seguintes validações:Campos obrigatórios:
nome: Mínimo 3 caracteresemail: Deve ser válido e únicotelefone: Aceita vários formatoscidade: Não pode ser vazioestado: Sigla com 2 letras
- Email não pode estar duplicado
- CNPJ/CPF são validados quando fornecidos
- Telefone é normalizado automaticamente
Códigos de Cliente
Se o campo
codigo não for fornecido, o sistema gera automaticamente:- Formato:
CLI+ número sequencial - Exemplos: CLI001, CLI002, CLI003…
- O código é único por empresa
- Você pode fornecer seu próprio código personalizado