"> "> "> "> "> "> "> "> "> "> ">
API OFICIAL GUILDERHUB

Integrações seguras para um ecossistema associativo conectado.

Conecte sites, aplicativos e sistemas externos ao GuilderHub por uma interface governada, versionada e multi-tenant, preservando isolamento, rastreabilidade e controle sobre os dados da associação.

POST /api/v1/associados/verificar
curl -X POST "https://guilderhub.com.br/api/v1/associados/verificar" \
  -H "Content-Type: application/json" \
  -H "X-Guilder-Token: gsh_live_••••••••" \
  -d '{"documento":"00000000000"}' 

{
  "success": true,
  "data": {
    "associado_ref": "assoc_••••••••",
    "matricula": "A-047",
    "status_cadastro": "ativo",
    "financeiro_regular": true,
    "acesso_liberado": true,
    "elegivel": true
  }
}
GOVERNANÇA, SEGURANÇA E PRIVACIDADE

A API é do GuilderHub. O controle dos dados continua com a associação.

A API GuilderHub é a camada oficial de integração da plataforma. Cada credencial é vinculada a uma única associação e possui permissões explícitas. Uma integração externa não recebe acesso irrestrito ao cadastro dos associados, credenciais, senhas, sessões ou recursos internos da GSI.

O GuilderHub aplica isolamento por tenant, princípio do menor privilégio, minimização de dados, rastreabilidade e limites de requisição. O tratamento e o compartilhamento de informações devem observar a finalidade autorizada, as responsabilidades aplicáveis à associação e à integração e a Lei Geral de Proteção de Dados Pessoais — LGPD.

Isolamento multi-tenant Escopos explícitos Minimização de dados Rate limit Auditoria técnica
CONTRATO TÉCNICO

API v1

A página pública vive em /api. Os sistemas consomem endpoints versionados em /api/v1.

Autenticação da integração

Envie a credencial exclusivamente no header X-Guilder-Token. O token é vinculado ao tenant e armazenado de forma não recuperável.

X-Guilder-Token: gsh_live_••••••••

Verificar associado

Consulta pontual por documento. A resposta padrão não entrega CPF, e-mail, telefone ou ID interno.

POST /api/v1/associados/verificar

{
  "documento": "00000000000"
}
associados:verificar · 120 req/min

Validar credenciais

Valida login e senha dentro do tenant autorizado. A senha nunca é retornada ou registrada em log.

POST /api/v1/associados/autenticar

{
  "login": "A-047",
  "senha": "••••••••"
}
associados:autenticar · 20 req/min

Identidade da integração

Permite validar a associação e os escopos vinculados ao token sem consultar dados de associados.

GET /api/v1/me
api:me · 120 req/min
01

Sem listagem irrestrita

A v1 base não disponibiliza exportação em massa da base de associados. Recursos adicionais exigem finalidade, autorização e escopo próprios.

02

Referência pública

Integrações recebem associado_ref opaco. O ID primário interno do GuilderHub não é contrato público.

03

Matrícula

O campo matricula representa o número associativo da pessoa dentro daquela associação. Ele não substitui a referência pública da API.

RESPOSTAS PADRONIZADAS

HTTP e JSON de verdade

Endpoints da API não retornam páginas HTML em caso de erro. Cada resposta inclui um request_id para rastreabilidade técnica.

200 Sucesso 401 Token/credencial inválida 403 Escopo ou tenant bloqueado 404 Recurso não localizado 405 Método não permitido 422 Entrada inválida 429 Rate limit
WEBHOOKS OFICIAIS

Eventos assinados, tenant-bound e com retry automático.

Use webhooks quando seu sistema precisa reagir a mudanças relevantes sem consultar a API continuamente. O GuilderHub envia apenas o estado público mínimo do associado, sem CPF, e-mail, telefone, senha ou ID interno.

Assinatura HMAC-SHA256

Cada associação possui um segredo próprio. Valide a assinatura antes de processar o evento.

X-Guilder-Event-Id: evt_...
X-Guilder-Event: associado.status_atualizado
X-Guilder-Timestamp: 1788510000
X-Guilder-Delivery-Attempt: 1
X-Guilder-Signature: v1=<hmac_sha256>
Conteúdo assinado: timestamp + "." + corpo_json_bruto. Valide também a janela de tempo do timestamp antes de aceitar a entrega.

Retry e idempotência

Responda HTTP 2xx somente depois de aceitar o evento. O mesmo event_id pode aparecer novamente em uma tentativa posterior e deve ser tratado de forma idempotente.

1 min 5 min 15 min 1 h 6 h encerrado após 6 tentativas

Eventos v1

associado.criado associado.status_atualizado associado.matricula_atualizada associado.regularidade_atualizada associado.acesso_atualizado associado.validade_atualizada webhook.test
EXEMPLO DE EVENTO

Payload mínimo e estável

O objeto changes informa somente os campos públicos que mudaram naquele evento.

{
  "id": "evt_...",
  "type": "associado.regularidade_atualizada",
  "api_version": "v1",
  "created_at": "2026-09-04T14:10:00Z",
  "data": {
    "associado": {
      "associado_ref": "assoc_...",
      "matricula": "A-047",
      "status_cadastro": "ativo",
      "financeiro_regular": true,
      "acesso_liberado": true,
      "elegivel": true,
      "validade_cadastro": "2027-03-31"
    },
    "changes": {
      "financeiro_regular": {
        "from": false,
        "to": true
      }
    }
  }
}
Proteção do endpoint receptor

O GuilderHub aceita somente endpoints HTTPS na porta 443 e bloqueia destinos locais, privados ou reservados. Redirecionamentos não são seguidos. A associação pode rotacionar o segredo, testar e desativar o webhook pela área de Integração API.