Início

API NewGestor

Documentação oficial da API REST do NewGestor — sistema de gestão de clientes.

Bem-vindo à API do NewGestor

A API REST do NewGestor deixa você ligar a sua gestão de clientes a plataformas externas como n8n, Make, Zapier, BotConversa e qualquer sistema que fale HTTP. Tudo que você lê e escreve por ela é da sua empresa — o token que você gera no painel já carrega essa informação.

O que dá para fazer

Cliente e revendedor são coisas diferentes

A API mexe com dois grupos de pessoas, e confundir os dois é o erro mais comum na primeira integração. Vale um minuto para separar:

Endereço base

Todo endereço desta documentação começa por aqui:

https://npanel.newgestor.com/api/v1

Autenticação

A API usa token do tipo Bearer. Gere o seu no painel, em API Tokens, e mande no cabeçalho Authorization de toda chamada.

Authorization: Bearer SEU_TOKEN_AQUI
Accept: application/json

Sem o cabeçalho, ou com um token apagado, a resposta é 401:

{
  "success": false,
  "message": "Unauthenticated"
}

Formato das respostas

Toda resposta é JSON e traz o campo success. Nas listagens, os registros vêm em data e as informações de página em meta.

{
  "success": true,
  "data": [
    { "id": 8412, "name": "Maria Souza", "status": "Ativo" }
  ],
  "meta": {
    "total": 1391,
    "per_page": 50,
    "current_page": 1,
    "last_page": 28,
    "company_id": 274
  }
}

Paginação

As listagens vêm paginadas. Controle com dois parâmetros na URL:

Para varrer a base inteira, suba page até chegar em meta.last_page:

curl "https://npanel.newgestor.com/api/v1/customers?per_page=200&page=2" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Accept: application/json"

Filtros da listagem de clientes

Todos são opcionais e podem ser combinados. Sem nenhum, a listagem devolve todos os clientes da empresa, do mais recente para o mais antigo.

Quem vence este mês e ainda está no plano 31, por exemplo:

curl "https://npanel.newgestor.com/api/v1/customers?status=vencido&plan_id=31&due_from=2026-10-01&due_to=2026-10-31" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Accept: application/json"

Checkout próprio com PIX

O /invoices//payment-link leva o pagador para o checkout do NewGestor. Se você tem a sua própria tela de pagamento, use POST /invoices//pix: ele devolve só o copia-e-cola e o QR Code.

{
  "success": true,
  "data": {
    "invoice": { "id": 1033077, "status": "Em aberto", "total_amount": "50.00" },
    "customer": { "id": 8412, "name": "Maria Souza" },
    "payment": {
      "provider": "mercadopago",
      "flow": "pix",
      "amount": 50.0,
      "pix_copy_paste": "00020126580014br.gov.bcb.pix0136…6304ABCD",
      "qr_code_base64": "iVBORw0KGgoAAAANSUhEUgAA…",
      "qr_code_data_uri": "data:image/png;base64,iVBORw0KGgo…",
      "checkout_url": null,
      "expires_at": "2026-09-11T20:00:00-03:00"
    },
    "notification": { "url": "https://seu-servidor.com/pagou", "event": "invoice.paid" }
  }
}

• A imagem é sempre PNG, seja qual for o gateway. Cada um devolve o QR de um jeito — PNG, SVG ou nada —, então ele é gerado a partir do copia-e-cola. Use qr_code_base64 puro ou qr_code_data_uri direto numa <img>.
• Chamar de novo não cria outra cobrança. Se já há uma pendente para a fatura, é ela que volta.
• O valor já inclui a taxa de serviço do gateway, se houver.

Alguns gateways não têm PIX direto — o InfinitePay, por exemplo, só oferece a página de pagamento dele. Nesses casos flow vem redirect, os campos de PIX vêm vazios e checkout_url traz o endereço:

"payment": {
  "provider": "infinitepay",
  "flow": "redirect",
  "pix_copy_paste": null,
  "qr_code_base64": null,
  "checkout_url": "https://checkout.infinitepay.io/…"
}

Sem gateway PIX configurado, a resposta é 422 dizendo exatamente isso.

Limite de uso

São 60 chamadas por minuto por token. Passando disso, a resposta vira 429 e o cabeçalho Retry-After diz quantos segundos esperar.

Códigos de erro

Quando algo não dá certo, o corpo traz success: false e uma message explicando o motivo.

Endpoints disponíveis

São trinta e nove. A lista completa, com parâmetros, exemplos em várias linguagens e o botão de testar direto do navegador, está na aba API Reference.

Conta

Clientes

Faturas

Planos e produtos dos clientes

Revendedores

Estes não têm relação com os clientes acima. Revendedor é quem contrata o painel de você para revender. No painel esta tela se chama "Usuários"; aqui o nome é explícito de propósito, para ninguém confundir com cliente. O link de cadastro sai daqui.

Webhooks

Cadastro dos endereços que recebem avisos. Detalhes, formato e assinatura na página Webhooks.

Níveis e permissões

Revendedores e planos só podem ser gerenciados por contas de revenda. As regras são as mesmas da tela do painel:

• Revendedor em teste não vira revenda — renove a assinatura antes.
• Voltar alguém para user é sempre permitido.
• Num plano de assinatura você só repassa funções que o seu plano tem, e o limite de cadastros nunca passa o seu.
• Ao alterar um plano, funções só são acrescentadas: quem já paga por uma não perde o acesso sem aviso.

Painel