API v1.0.0

API WHMCS

Camada de integração enterprise-grade para múltiplas instâncias WHMCS. Segura, auditável e escalável.

Ver Documentação Testar API
Entrar Criar Conta

Recursos Principais

Tudo que você precisa para integrar seus sistemas com WHMCS de forma segura e eficiente

Segurança Máxima

Autenticação por token com hash SHA-256, rate limiting, e logs sanitizados para proteger seus dados.

  • Tokens em hash (nunca plain text)
  • Permissões granulares
  • Logs sem dados sensíveis

Multi-WHMCS

Gerencie múltiplas instâncias WHMCS de forma transparente com resolução automática por tenant.

  • Instâncias ilimitadas
  • Resolução por prioridade
  • Isolamento por tenant

Auditoria Completa

Todas as requisições são registradas com payload sanitizado, duração e instância WHMCS usada.

  • Rastreabilidade completa
  • Métricas de performance
  • Logs à prova de falhas

Alta Performance

Construído com Laravel 13 e PHP 8.3+, com cache, filas e rate limiting para alta vazão.

  • PHP 8.3+
  • Redis e filas
  • Rate limiting inteligente

API RESTful

Endpoints bem desenhados, orientados a recursos, com respostas JSON consistentes e padronizadas.

  • Contrato estável
  • Versionamento (/v1)
  • Amigável para bots

Fácil Integração

Documentação completa, exemplos de código e respostas de erro claras para integração rápida.

  • Documentação completa
  • Exemplos práticos
  • SDKs futuros

Comece em Minutos

Três passos simples para começar a usar a API WHMCS.

1

Obtenha seu Token

Rode o seeder de desenvolvimento para receber seu token de acesso.

2

Configure o Header

Adicione o token no header Authorization: Bearer.

3

Faça Requisições

Comece a consumir os endpoints da API.

Exemplo cURL 
# 1. Obter token (apenas uma vez)
php artisan db:seed --class=DevelopmentSeeder

# 2. Fazer requisição
curl -X GET "https://api.whmcs.vplaysh.top/v1/me" \
  -H "Authorization: Bearer sk_dev_xxx" \
  -H "Content-Type: application/json"

# 3. Ver resposta
{
  "success": true,
  "message": "Contexto do consumidor",
  "data": { ... }
}

Endpoints Disponíveis

API completa para gerenciar clientes, serviços e faturas no WHMCS

Health Check

GET /api/v1/health

Verifica o status de saúde da API. Não requer autenticação.

Clientes

POST /api/v1/clients/search Buscar clientes
GET /api/v1/clients/{id} Detalhes do cliente
GET /api/v1/clients/{id}/summary Resumo do cliente

Serviços

GET /api/v1/services/{id} Detalhes do serviço
GET /api/v1/services/{id}/summary Resumo do serviço
POST /api/v1/services/{id}/suspend Suspender serviço
POST /api/v1/services/{id}/unsuspend Reativar serviço

Faturas

POST /api/v1/invoices/search Buscar faturas
GET /api/v1/invoices/{id} Detalhes da fatura
GET /api/v1/clients/{id}/open-invoices Faturas em aberto
Ver documentação completa