Crie acesso refinado para a API Fax.Plus usando Tokens de Acesso Pessoal

Tokens de acesso pessoal (PATs) fornecem acesso seguro e refinado à API Fax.Plus. Este guia irá guiá-lo através do processo de criação e gerenciamento de tokens com as permissões apropriadas para suas necessidades de integração.

Criando um token de acesso pessoal

Geração do token de acesso

1. Faça login no painel Fax.Plus em app.fax.plus
2. Navegue para Perfil > Integrações > Tokens de Acesso Pessoal
3. Clique em "Gerar Novo Token"

Configuração do token

Ao gerar um novo token, você precisará configurar:

1. Nome do token: Escolha um nome descritivo que identifique a finalidade do token
2. Expiração: Defina uma data de expiração personalizada (Recomendado: 90 dias)

Âmbitos disponíveis

Selecione um ou mais dos seguintes escopos para definir as permissões de acesso do token:

Acesso Geral

• fax:all:read- Acesso somente leitura para todas as operações relacionadas com fax
  • Exibir faxes, usuários, membros e números
• fax:all:edit - Acesso total a todas as operações relacionadas com fax
  • Gerenciar faxes, usuários, membros, webhooks, e números

Gerenciamento de webhook

• fax:webhook:read- Visualizar configurações do webhook

• fax:webhook:edit- Recursos completos de gerenciamento de webhook

Operações de Fax

• fax:fax:read- Acesso para ver faxes
  • Ver listas de saída, arquivos de fax e relatórios
• fax:fax:edit- Permissões completas de gerenciamento de fax 
  • Gerenciar caixa, arquivos e detalhes do fax

Gerenciamento de usuários

• fax:use:read- Ver detalhes do usuário atual (PAT proprietário)
• fax:user:edit- Atualiza os detalhes do usuário atual

Recursos de Loja

• fax:shop:read- Procure números de fax e verifique o saldo de créditos
• fax:shop:edit- Comprar números

Acesso de Membro

• fax:member:read- Ver detalhes da conta e do membro
• fax:member:edit- Gerenciar informações de membro

Gerenciamento de números

• fax:numbers:read- Lista e exibir números de fax
• fax:numbers:edit- Gerenciamento completo de números de fax

Melhores Práticas de Segurança

1. Princípio de Menos Privilégio
   • Só conceda escopos que são absolutamente necessários para a sua integração
   • Usar escopos somente leitura quando não for necessário acesso de gravação
2. Rotação dos Tokens
   • Girar tokens a cada 90 dias
   • Definir um lembrete para rotação do token
   • Crie novos tokens antes dos antigos expirarem para garantir o serviço contínuo
3. Gerenciamento de Tokens
   • Mantenha os tokens seguros e nunca os compartilhe
   • Revogar tokens imediatamente se estiver comprometido
   • Armazenar tokens de forma segura na configuração do seu aplicativo

Dicas de implementação

1. Seleção de escopo
   • Para operações somente leitura, use *:readescopos
   • Para gerenciamento completo, use *:editescopos
   • Considere usar o fax:all:readou fax:all:editpara necessidades gerais de acesso
2. Testando
   • Teste sua integração com escopos mínimos primeiro
   • Adicione gradualmente escopos conforme necessário
   • Verifique a manipulação de expiração de token na sua aplicação

Solução de problemas

Se você encontrar problemas de acesso:

1. A verificação do token não expirou
2. Confirme que você selecionou todos os escopos necessários
3. Verificar se o token foi revogado
4. Certifique-se de usar o token corretamente nas solicitações da API