Pular para o conteúdo

Chaves de API

A API REST do Pliic é autenticada com chaves secretas (sk_live_…), uma por app. Cada chave carrega um conjunto de escopos que limitam o que ela pode acessar.

A API está disponível nos planos Starter e Pro. O plano Gratuito não inclui este recurso.

Acesse Configurações → Chaves de API. A página lista cada app da equipe com a sua chave secreta, os escopos atuais, o último uso e o status (ativa ou revogada).

Apenas membros com papel Administrador ou Dono podem visualizar e gerenciar as chaves de API.

Os escopos definem quais partes da API a chave pode usar:

EscopoPermite
suggestions:readLer sugestões
suggestions:writeCriar e atualizar sugestões
tickets:readLer tickets de suporte
tickets:writeCriar e atualizar tickets
analytics:readLer dados de analytics
privacy:readExportar dados de privacidade do usuário
privacy:writeExcluir dados de privacidade do usuário

Selecione Acesso total para conceder todos os escopos atuais e futuros.

Em Ações da chave → Rotacionar chave, uma nova chave secreta é gerada e exibida uma única vez. Os escopos são preservados, mas a chave antiga deixa de funcionar imediatamente. Atualize suas integrações com o novo valor antes de fechar o aviso.

Revogar desativa a chave imediatamente: qualquer requisição passa a retornar 401. Use Restaurar para reativá-la. A chave secreta em si não muda ao revogar/restaurar.

O botão Referência da API abre a documentação interativa (OpenAPI) com todos os endpoints, parâmetros e exemplos. A especificação também está disponível publicamente em /api/v1/openapi.json.