Autenticação e segurança

Como autenticar, o que cada escopo permite e o que nunca deve vazar.

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.

Veja o header Bearer no API Playground (placeholder WPIX_API_KEY).

Header Bearer#

Envie a chave completa no header HTTP:

http

Authorization: Bearer ak_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

401 — chave ausente, inválida ou revogada
403 — chave sem o escopo exigido pelo endpoint

Escopos#

Hoje a API v1 de leitura exige donations:read em GET /api/v1/donations e GET /api/v1/donations/{id}. GET /api/v1/me valida a chave sem escopo adicional.

Boas práticas#

Armazene chaves em variáveis de ambiente do servidor (Vault, 1Password, CI secrets).
Não commite chaves em git, logs ou tickets.
Revogue chaves comprometidas no dashboard imediatamente.
Defina expiração quando a integração for temporária.

Detalhes de rate limit: Erros e limites.

Developers

API V1Voltar ao Wpix

Wpix Developers / API v1

Autenticação e segurança

Como autenticar, o que cada escopo permite e o que nunca deve vazar.

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.

Veja o header Bearer no API Playground (placeholder WPIX_API_KEY).

Header Bearer#

Envie a chave completa no header HTTP:

http

Authorization: Bearer ak_live_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

401 — chave ausente, inválida ou revogada
403 — chave sem o escopo exigido pelo endpoint

Escopos#

Hoje a API v1 de leitura exige donations:read em GET /api/v1/donations e GET /api/v1/donations/{id}. GET /api/v1/me valida a chave sem escopo adicional.

Boas práticas#

Armazene chaves em variáveis de ambiente do servidor (Vault, 1Password, CI secrets).
Não commite chaves em git, logs ou tickets.
Revogue chaves comprometidas no dashboard imediatamente.
Defina expiração quando a integração for temporária.

Detalhes de rate limit: Erros e limites.

Autenticação e segurança · Wpix Developers