Integrações comerciais

Conecte vendas e cobrança à operação técnica.

Uma base única para criar módulos do CastleManager, WHMCS e outras plataformas sem duplicar provisionamento, permissões ou regras dos planos.

Guia CastleManager Blueprint WHMCS
API v1 disponível SSO especificado Modelo extensível
API únicacontrato técnico central
Servidor a servidorsegredos fora do navegador
Fila auditadaoperações pelo CastleAgent
SSO de uso únicoacesso sem compartilhar senha
Plataformas

Escolha o ponto de partida

Cada módulo usa a mesma API, mas respeita o ciclo comercial e a experiência de sua plataforma.

CMEm evolução

CastleManager

Integração nativa da CastleHosting para pedidos, serviços, recursos técnicos e acesso transparente ao CastlePanel.

  • Clientes, serviços, sites e planos.
  • E-mails, bancos, SFTP e SSL.
  • Fila do CastleAgent e auditoria.
  • SSO de cliente, administrador e suporte.
Abrir especificação
WHBlueprint

WHMCS

Projeto de módulo de provisionamento compatível com o fluxo comercial tradicional do WHMCS.

  • Create, suspend, unsuspend e terminate.
  • Upgrade e downgrade de plano.
  • Área do cliente e ações técnicas.
  • Service e Admin Single Sign-On.
Ver arquitetura
APIModelo base

Outros sistemas

Blesta, HostBill, ERP próprio ou aplicativo interno podem seguir o mesmo contrato de integração.

  • Adaptador comercial separado.
  • Mapeamento estável de identificadores.
  • Idempotência e consulta de operações.
  • Permissões mínimas por credencial.
Como criar
Arquitetura

Uma divisão simples de responsabilidades

  1. 01Plataforma comercialPedido, pagamento, sessão e interface do cliente.
  2. 02Adaptador do móduloTraduz eventos comerciais para o contrato da API.
  3. 03CastlePanel APIValida escopo, plano, recurso e idempotência.
  4. 04CastleAgentExecuta a operação real e registra o resultado.

A plataforma comercial nunca acessa diretamente o banco do CastlePanel e nunca executa comandos no servidor.

Novo conector

O que todo módulo precisa implementar

Este checklist evita integrações frágeis e facilita adicionar novas plataformas mais tarde.

01

Cliente da API

Bearer, HMAC, timestamp, identificador da requisição, idempotência e tratamento padronizado de erros.

02

Mapeamento de IDs

Relacionar cliente, serviço e site comercial aos identificadores permanentes do CastlePanel.

03

Ciclo do serviço

Criar, alterar plano, suspender, reativar, cancelar e excluir definitivamente em ações separadas.

04

Recursos técnicos

Expor somente e-mails, bancos, SFTP, SSL e operações autorizadas para aquele cliente.

05

Operações assíncronas

Guardar o operation ID, consultar o CastleAgent e mostrar andamento, conclusão ou falha.

06

SSO seguro

Ticket de uso único, validade curta, consumo por POST e sessão criada no escopo correto.

Contrato técnico

Recursos disponíveis na API v1

A API já organiza as operações que uma plataforma comercial precisa oferecer no dia a dia.

Clientes e serviçoscadastro, plano, suspensão, reativação e cancelamento
Sitescriação e provisionamento controlado
E-mailscaixas postais, estado e acesso ao webmail
BancosMariaDB, usuário, acesso e ciclo de vida
SFTPcontas isoladas por domínio ou pasta
SSLemissão, renovação e remoção com checagem DNS
Operaçõesconsulta do estado de cada tarefa do CastleAgent
Acesso transparente

SSO sem compartilhar credenciais

O botão de acesso usa um ticket temporário e cria uma sessão nova no CastlePanel.

Cliente

Acessar meu painel

Abre somente os clientes, serviços e domínios pertencentes à sessão comercial.

Admin

Acessar administração

Exige usuário administrativo mapeado, permissão específica e autenticação forte recente.

Suporte

Visualizar como cliente

Mantém o ator real na auditoria e mostra um aviso fixo durante a visualização delegada.

Estado atual: o contrato de SSO está especificado, mas os endpoints de emissão e consumo do ticket precisam ser publicados antes de ativar os botões.
Base preparada

Um novo sistema comercial começa pelo adaptador, não por outra API.

Use o guia desta área para preservar segurança, limites de plano, auditoria e a experiência do cliente.

Implementar CastleManager Consultar OpenAPI