API V1Voltar ao Wpix

Wpix Developers / API v1

Sua stream, conectada ao seu produto.

Leve doações confirmadas da Wpix para o backend da sua comunidade, automação ou ferramenta — com chaves isoladas, webhooks assinados e uma API feita para servidor.

Criar primeira integração Explorar referência

Read-only

A API v1 começa segura: leitura de doações confirmadas.

Server-to-server

Chaves por integração. Nunca exponha segredos no cliente.

OpenAPI

Contrato legível por humanos e ferramentas.

Wpix Developers / API v1

Comece pelo fluxo certo

Escolha a integração mínima que resolve seu caso. Você pode crescer a partir daí, sem entregar mais acesso do que o necessário.

Base URL#

Todas as rotas vivem em /api/v1. Em produção use https://wpix.online/api/v1; em staging, https://staging.wpix.online/api/v1.

Fluxo típico#

Crie uma integração em /dashboard/canal?tab=configuracoes&section=api.
Gere uma chave com escopo mínimo (donations:read).
Chame GET /api/v1/me para validar a chave.
Liste ou detalhe doações com GET /api/v1/donations.
Opcional: configure webhook donation.created no dashboard.

Especificação#

Contrato machine-readable em /openapi/v1.yaml — servido diretamente de docs/specs/openapi-v1.yaml no repositório.

Começar agora Ver endpoints

Visão geral | Wpix