WebSystem Provider API — Página Principal

Destaques

Multi-Tenant

Isolamento por provedor, tema e logos personalizados.

Autenticação

Bearer Token (apps) e API Key (integrações externas).

NFCom

PDF e XML direto da API com segurança.

Notificações

Push para clientes, técnicos e administradores.

Como começar

Escolha uma trilha abaixo para avançar.

Ler Documentação Ver Endpoints Guia de Integração Exemplos de Teste

Introdução

Esta API utiliza versionamento por URL (ex: /v1) e retorna respostas padronizadas em JSON.

Autenticação

Apps: Bearer Token via /auth/login. Integrações: API Key via header X-API-Key.

Autenticação

# Login
curl -X POST \
  -H "Content-Type: application/json" \
  -d '{"cpf_cnpj":"00000000191","senha":"123456"}' \
  https://api.seuprovedor.com.br/v1/auth/login

// Uso do token
const res = await fetch('/v1/client', { headers: { Authorization: `Bearer ${token}` } });
const json = await res.json();

Try It: Login

Teste o endpoint de login e veja a resposta formatada abaixo.

Tratamento de Erros

Utilize o campo success, message e errors para interpretação de respostas.

401: Token inválido ou ausente.
403: Sem permissão para o recurso.
429: Rate limit excedido.

Referência de Endpoints

Auth

POST /auth/login, POST /auth/logout, GET /auth/check, POST /auth/refresh

Cliente

GET/PUT /client; GET /clientes 🔑; CRUD /clientes 🔑

Faturas & NFCom

GET /invoices, GET /invoices/{id}, GET /invoices/{id}/second-copy, GET /invoices/{id}/nfcom, PDF/XML

Chamados

GET/POST /tickets; POST/PUT /chamados 🔑

Rede

GET /network/* (overview, servers, topology, traffic)

Webhooks

CRUD /webhooks 🔑 e logs

Consulte também o arquivo REFERENCIA_API.md para a lista detalhada com payloads.

Guia de Integração (WebSystem)

Integrações externas devem usar X-API-Key com escopos e, opcionalmente, whitelist de IPs.

Eventos de webhook: cliente.*, fatura.*, nfcom.*, chamado.*.

SDKs (planejados): JavaScript, PHP, Python.

Leitura completa: GUIA_INTEGRACAO.md

Exemplo de API Key

curl -H "X-API-Key: sk_live_abc123" \ 
  "https://api.seuprovedor.com.br/v1/clientes?limit=50&situacao=ativo"

Exemplos Rápidos

Login

curl -X POST -H "Content-Type: application/json" \
  -d '{"cpf_cnpj":"00000000191","senha":"123456"}' \
  https://api.seuprovedor.com.br/v1/auth/login

Listar Faturas

curl -H "Authorization: Bearer TOKEN" \
  "https://api.seuprovedor.com.br/v1/invoices?status=aberta&limit=20"

NFCom PDF

curl -H "Authorization: Bearer TOKEN" \
  -L "https://api.seuprovedor.com.br/v1/invoices/123/nfcom/download" -o nfcom.pdf

Veja o guia completo de testes: TESTES.md