curl -X GET "https://api.sistema-representantes.com.br/api/v1/clients?page=1&limit=20" \
-H "x-api-key: sua-api-key-aqui"
curl -X GET "https://api.sistema-representantes.com.br/api/v1/clients?search=paulo" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/clients?page=1&limit=20', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
console.log(`Total de clientes: ${result.total}`);
console.log(`Clientes nesta página: ${result.data.length}`);
import requests
url = "https://api.sistema-representantes.com.br/api/v1/clients"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
params = {
'page': 1,
'limit': 20,
'search': 'empresa'
}
response = requests.get(url, headers=headers, params=params)
result = response.json()
if response.status_code == 200:
print(f"Total de clientes: {result['total']}")
for client in result['data']:
print(f"- {client['nome']} ({client['codigo']})")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
<?php
$url = 'https://api.sistema-representantes.com.br/api/v1/clients';
$headers = [
'x-api-key: sua-api-key-aqui'
];
$params = http_build_query([
'page' => 1,
'limit' => 20
]);
$options = [
'http' => [
'header' => implode("\r\n", $headers),
'method' => 'GET'
]
];
$context = stream_context_create($options);
$result = file_get_contents($url . '?' . $params, false, $context);
$response = json_decode($result, true);
if ($response) {
echo "Total de clientes: " . $response['total'] . "\n";
foreach ($response['data'] as $client) {
echo "- " . $client['nome'] . " (" . $client['codigo'] . ")\n";
}
}
?>
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"codigo": "CLI001",
"nome": "Empresa ABC Ltda",
"cnpj_cpf": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 98765-4321",
"endereco": "Rua das Flores, 123",
"cidade": "São Paulo",
"estado": "SP",
"ativo": true,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T14:25:00Z"
},
{
"id": "987e6543-e89b-12d3-a456-426614174999",
"codigo": "CLI002",
"nome": "Comércio XYZ",
"cnpj_cpf": "98.765.432/0001-10",
"email": "[email protected]",
"telefone": "(21) 91234-5678",
"endereco": "Av. Principal, 456",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"ativo": true,
"created_at": "2024-01-10T08:15:00Z",
"updated_at": "2024-01-10T08:15:00Z"
}
],
"page": 1,
"limit": 20,
"total": 150
}
{
"data": [],
"page": 1,
"limit": 20,
"total": 0
}
{
"error": "API key ausente"
}
{
"error": "API key inválida"
}
{
"error": "Empresa inativa"
}
Clientes
Listar Clientes
Lista todos os clientes cadastrados com paginação e busca
GET
/
api
/
v1
/
clients
curl -X GET "https://api.sistema-representantes.com.br/api/v1/clients?page=1&limit=20" \
-H "x-api-key: sua-api-key-aqui"
curl -X GET "https://api.sistema-representantes.com.br/api/v1/clients?search=paulo" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/clients?page=1&limit=20', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
console.log(`Total de clientes: ${result.total}`);
console.log(`Clientes nesta página: ${result.data.length}`);
import requests
url = "https://api.sistema-representantes.com.br/api/v1/clients"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
params = {
'page': 1,
'limit': 20,
'search': 'empresa'
}
response = requests.get(url, headers=headers, params=params)
result = response.json()
if response.status_code == 200:
print(f"Total de clientes: {result['total']}")
for client in result['data']:
print(f"- {client['nome']} ({client['codigo']})")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
<?php
$url = 'https://api.sistema-representantes.com.br/api/v1/clients';
$headers = [
'x-api-key: sua-api-key-aqui'
];
$params = http_build_query([
'page' => 1,
'limit' => 20
]);
$options = [
'http' => [
'header' => implode("\r\n", $headers),
'method' => 'GET'
]
];
$context = stream_context_create($options);
$result = file_get_contents($url . '?' . $params, false, $context);
$response = json_decode($result, true);
if ($response) {
echo "Total de clientes: " . $response['total'] . "\n";
foreach ($response['data'] as $client) {
echo "- " . $client['nome'] . " (" . $client['codigo'] . ")\n";
}
}
?>
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"codigo": "CLI001",
"nome": "Empresa ABC Ltda",
"cnpj_cpf": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 98765-4321",
"endereco": "Rua das Flores, 123",
"cidade": "São Paulo",
"estado": "SP",
"ativo": true,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T14:25:00Z"
},
{
"id": "987e6543-e89b-12d3-a456-426614174999",
"codigo": "CLI002",
"nome": "Comércio XYZ",
"cnpj_cpf": "98.765.432/0001-10",
"email": "[email protected]",
"telefone": "(21) 91234-5678",
"endereco": "Av. Principal, 456",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"ativo": true,
"created_at": "2024-01-10T08:15:00Z",
"updated_at": "2024-01-10T08:15:00Z"
}
],
"page": 1,
"limit": 20,
"total": 150
}
{
"data": [],
"page": 1,
"limit": 20,
"total": 0
}
{
"error": "API key ausente"
}
{
"error": "API key inválida"
}
{
"error": "Empresa inativa"
}
Retorna uma lista paginada de clientes. Suporta busca por nome, código, cidade ou email.
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 registros por página (máximo: 100)
string
Termo de busca. Procura em:
- Nome do cliente
- Código
- Cidade
curl -X GET "https://api.sistema-representantes.com.br/api/v1/clients?page=1&limit=20" \
-H "x-api-key: sua-api-key-aqui"
curl -X GET "https://api.sistema-representantes.com.br/api/v1/clients?search=paulo" \
-H "x-api-key: sua-api-key-aqui"
const response = await fetch('https://api.sistema-representantes.com.br/api/v1/clients?page=1&limit=20', {
method: 'GET',
headers: {
'x-api-key': 'sua-api-key-aqui'
}
});
const result = await response.json();
console.log(`Total de clientes: ${result.total}`);
console.log(`Clientes nesta página: ${result.data.length}`);
import requests
url = "https://api.sistema-representantes.com.br/api/v1/clients"
headers = {
'x-api-key': 'sua-api-key-aqui'
}
params = {
'page': 1,
'limit': 20,
'search': 'empresa'
}
response = requests.get(url, headers=headers, params=params)
result = response.json()
if response.status_code == 200:
print(f"Total de clientes: {result['total']}")
for client in result['data']:
print(f"- {client['nome']} ({client['codigo']})")
else:
print(f"Erro: {result.get('error', 'Erro desconhecido')}")
<?php
$url = 'https://api.sistema-representantes.com.br/api/v1/clients';
$headers = [
'x-api-key: sua-api-key-aqui'
];
$params = http_build_query([
'page' => 1,
'limit' => 20
]);
$options = [
'http' => [
'header' => implode("\r\n", $headers),
'method' => 'GET'
]
];
$context = stream_context_create($options);
$result = file_get_contents($url . '?' . $params, false, $context);
$response = json_decode($result, true);
if ($response) {
echo "Total de clientes: " . $response['total'] . "\n";
foreach ($response['data'] as $client) {
echo "- " . $client['nome'] . " (" . $client['codigo'] . ")\n";
}
}
?>
Response
array
Array contendo os clientes encontrados
Show Estrutura do cliente
Show Estrutura do cliente
string
ID único do cliente (UUID)
string
Código personalizado do cliente
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 com 2 letras)
boolean
Se o cliente está ativo
string
Data de criação no formato ISO 8601
string
Data da última atualização
number
Página atual
number
Limite de registros por página
number
Total de clientes no banco de dados
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"codigo": "CLI001",
"nome": "Empresa ABC Ltda",
"cnpj_cpf": "12.345.678/0001-90",
"email": "[email protected]",
"telefone": "(11) 98765-4321",
"endereco": "Rua das Flores, 123",
"cidade": "São Paulo",
"estado": "SP",
"ativo": true,
"created_at": "2024-01-15T10:30:00Z",
"updated_at": "2024-01-20T14:25:00Z"
},
{
"id": "987e6543-e89b-12d3-a456-426614174999",
"codigo": "CLI002",
"nome": "Comércio XYZ",
"cnpj_cpf": "98.765.432/0001-10",
"email": "[email protected]",
"telefone": "(21) 91234-5678",
"endereco": "Av. Principal, 456",
"cidade": "Rio de Janeiro",
"estado": "RJ",
"ativo": true,
"created_at": "2024-01-10T08:15:00Z",
"updated_at": "2024-01-10T08:15:00Z"
}
],
"page": 1,
"limit": 20,
"total": 150
}
{
"data": [],
"page": 1,
"limit": 20,
"total": 0
}
{
"error": "API key ausente"
}
{
"error": "API key inválida"
}
{
"error": "Empresa inativa"
}
Paginação
Para navegar pelos resultados:
- Use
pagepara especificar a página desejada - O
limitcontrola quantos registros por página (máximo 100) - O campo
totalindica quantos registros existem no total
const lastPage = Math.ceil(total / limit);
Busca
O parâmetro
search realiza busca em múltiplos campos simultaneamente:- Nome: Busca parcial, não case-sensitive
- Código: Busca parcial
- Cidade: Busca parcial
- Email: Busca parcial
?search=paulo retornará:- Clientes com “Paulo” no nome
- Clientes em “São Paulo”
- Clientes com “paulo” no email