P&S2B
PES2B AgentDeveloper Portal
AGENT 1.1.0 • EXECUÇÃO LOCAL

Orquestração segura de automações locais

O PES2B Agent recebe comandos autorizados, descobre pacotes instalados, cria jobs assíncronos e disponibiliza resultados e arquivos sem expor diretamente a sessão gráfica do Windows.

Começar integraçãoReferência OpenAPI

O Agent é usado apenas para execuções locais. APIs hospedadas na VPS são consumidas diretamente.

DISPONIBILIDADE

Status documental

Releasev1.1.0
EscopoRede local
FilaAssíncrona
AutenticaçãoAPI Key
Observação: este portal não consulta o Agent local. A saúde operacional deve ser verificada em GET /health dentro da rede autorizada.
ARQUITETURA

Posição na Plataforma PES2B

n8n

Decide o processo de negócio.

PES2B Agent

Gerencia pacotes, fila, jobs e arquivos locais.

Desktop Worker

Executa comandos na sessão gráfica.

RPAs locais

Playwright, Node, PowerShell e outros.

SEGURANÇA

Autenticação

Exceto /health, as rotas exigem o cabeçalho:

X-PES2B-API-KEY: SUA_CHAVE
Não exponha o Agent à internet. Use Tailscale, VPN ou rede privada e mantenha a chave em credenciais do n8n.
INTEGRAÇÃO

Primeiros passos

1

Confirme GET /health.

2

Liste os pacotes em /api/v1/automations.

3

Crie o job com POST /api/v1/automations/:id/run.

4

Consulte GET /api/v1/jobs/:id até um estado terminal.

5

Baixe os arquivos registrados, quando houver.

curl -X POST 'http://127.0.0.1:3000/api/v1/automations/dec-poa/run' \
  -H 'Content-Type: application/json' \
  -H 'X-PES2B-API-KEY: SUA_CHAVE' \
  -d '{"requestId":"exemplo-001","input":{}}'
API REST

Endpoints

GET/healthPúblico local
GET/api/v1/automationsAPI Key
POST/api/v1/automations/:id/runAPI Key
GET/api/v1/jobs/:idAPI Key
GET/api/v1/jobs/:jobId/filesAPI Key
EXECUÇÃO

Estados de job

EstadoSignificado
QUEUEDAguardando execução.
RUNNINGPacote em processamento.
SUCCEEDEDExecução concluída.
FAILEDFalha terminal.
TIMED_OUTTempo limite excedido.
ARTEFATOS

Arquivos de saída

O Agent registra arquivos somente em raízes autorizadas, relaciona-os ao job e fornece URLs de download autenticadas. Os registros possuem retenção configurável.

AMBIENTE

Configuração principal

VariávelPadrãoDescrição
HOST127.0.0.1Interface de escuta.
PORT3000Porta HTTP.
PES2B_API_KEY—Chave obrigatória.
AUTOMATIONS_ROOTC:\PES2B\AutomacoesRaiz dos pacotes.
MAX_CONCURRENT_JOBS1Concorrência global.
FILE_RETENTION_DAYS7Retenção de registros.
DIAGNÓSTICO

Erros comuns

{
  "error": "Invalid or missing API key."
}

{
  "error": "Automation not found."
}
GOVERNANÇA

Segurança

  • Escuta local por padrão.
  • Chave obrigatória nas rotas operacionais.
  • Allowlist de raízes para arquivos.
  • Logs e request IDs para rastreabilidade.
  • Não publique segredos em workflows exportados.
ARQUIVOS

Downloads

Documentação MarkdownOpenAPI JSONPostman