Criar acesso granular à API Fax.Plus através de Tokens de Acesso Pessoal

Os Tokens de Acesso Pessoal (PATs) proporcionam acesso seguro e granular à API Fax.Plus. Este guia irá orientá-lo ao longo do processo de criação e gestão de tokens com as permissões adequadas às necessidades da sua integração.

Criar um Token de Acesso Pessoal

Geração do token de acesso

1. Inicie sessão no seu painel Fax.Plus em app.fax.plus
2. Navegue até Definições > Integrações > Tokens de Acesso Pessoal
3. Clique em „Gerar Novo Token“

Configuração do token

Ao gerar um novo token, terá de 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 âmbitos para definir as permissões de acesso do token:

Acesso geral

• fax:all:read- Acesso apenas de leitura a todas as operações relacionadas com fax
  • Ver faxes, utilizadores, membros e números
• fax:all:edit - Acesso total a todas as operações relacionadas com fax
  • Gerir faxes, utilizadores, membros, webhooks e números

Gestão de webhooks

• fax:webhook:read- Ver configurações de webhooks

• fax:webhook:edit- Capacidades completas de gestão de webhooks

Operações de fax

• fax:fax:read- Acesso para ver faxes
  • Ver listas da caixa de saída, ficheiros de fax e relatórios
• fax:fax:edit- Permissões completas de gestão de faxes 
  • Gerir a caixa de saída, os ficheiros e os detalhes dos faxes

Gestão de utilizadores

• fax:use:read- Ver detalhes do utilizador atual (proprietário do PAT)
• fax:user:edit - Atualizar detalhes do utilizador atual

Funcionalidades da loja

• fax:shop:read- Consultar números de fax e verificar o saldo de crédito
• fax:shop:edit- Comprar números

Acesso de membros

• fax:member:read- Ver detalhes da conta e dos membros
• fax:member:edit- Gerir informações dos membros

Gestão de números

• fax:numbers:read - Listar e ver números de fax
• fax:numbers:edit- Gestão completa de números de fax

Melhores práticas de segurança

1. Princípio do privilégio mínimo
   • Conceda apenas os âmbitos absolutamente necessários para a sua integração
   • Utilize âmbitos apenas de leitura quando não for necessário acesso de escrita
2. Rotação de tokens
   • Efetue a rotação dos tokens a cada 90 dias
   • Defina um lembrete para a rotação de tokens
   • Crie novos tokens antes que os antigos expirem, para garantir a continuidade do serviço
3. Gestão de tokens
   • Mantenha os tokens seguros e nunca os partilhe
   • Revogue os tokens imediatamente se forem comprometidos
   • Armazene os tokens de forma segura na configuração da sua aplicação

Dicas de implementação

1. Seleção de âmbitos
   • Para operações apenas de leitura, utilize âmbitos *:read
   • Para gestão completa, utilize âmbitos *:edit
   • Considere utilizar fax:all:readou fax:all:edit para necessidades de acesso mais amplas
2. Testes
   • Teste primeiro a sua integração com âmbitos mínimos
   • Adicione âmbitos gradualmente, conforme necessário
   • Verifique o tratamento da expiração do token na sua aplicação

Resolução de problemas

Se encontrar problemas de acesso:

1. Verifique se o token não expirou
2. Confirme se selecionou todos os âmbitos necessários
3. Verifique se o token foi revogado
4. Certifique-se de que está a utilizar o token corretamente nos pedidos à API