API V1Voltar ao Wpix

Wpix Developers / API v1

Primeiros passos

Do zero à primeira resposta 200 em poucos minutos — sem expor segredos no cliente.

Wpix developer console

Veja o fluxo em ação

Simulado

Escolha uma etapa, troque a linguagem e leve o código para o seu backend. Nenhuma chamada é feita daqui.

Confirma a chave e retorna streamer + escopos. Não exige donations:read.

GET/api/v1/me

Request

$ curl -sS "https://SEU_DOMINIO/api/v1/me" \
  -H "Authorization: Bearer $WPIX_API_KEY"

Exemplo de resposta

{
  "streamer": {
    "id": "00000000-0000-4000-8000-000000000001",
    "display_name": "Canal Exemplo",
    "slug": "canal-exemplo"
  },
  "scopes": ["donations:read"]
}

Use WPIX_API_KEY apenas no servidor. Para ver todo o contrato, consulte a especificação OpenAPI.

Use o API Playground ao lado (ou acima no mobile) para copiar exemplos em cURL, Node.js e Python.

1. No dashboard#

Acesse Canal → Configurações → API (/dashboard/canal?tab=configuracoes&section=api).

Crie uma integração (nome do app ou parceiro).
Gere uma chave com escopo donations:read.
Guarde ak_live_… em cofre — exibida uma única vez.

2. Primeira chamada#

Validar API keybash

curl -s https://SEU_DOMINIO/api/v1/me \
  -H "Authorization: Bearer ak_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

Resposta esperada (200): identificação do streamer e escopos da chave.

3. Listar doações#

bash

curl -s "https://SEU_DOMINIO/api/v1/donations?limit=20" \
  -H "Authorization: Bearer ak_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

Por padrão retorna somente doações RECEIVED. Use next_cursor como before na página seguinte.

Primeiros passos · Wpix Developers