Crie acesso detalhado à API do Fax.Plus com Personal Access Tokens

Os Personal Access Tokens (PATs) proporcionam acesso seguro e detalhado à API do Fax.Plus. Este guia explica como criar e gerir tokens com as permissões adequadas às necessidades da sua integração.

Criar um Personal Access Token

Geração do token de acesso

1. Inicie sessão no seu painel do Fax.Plus em app.fax.plus
2. Aceda a Definições > Integrações > Personal Access Tokens
3. Clique em „Gerar novo token“

Configuração do token

Ao gerar um novo token, tem 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 só 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 as configurações de webhooks

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

Operações de fax

• fax:fax:read

  - Acesso para visualizar faxes

  • Ver listas da caixa de saída, ficheiros de fax e relatórios
• fax:fax:edit

  - Permissões de gestão completa de fax 

  • Gerir a caixa de saída, os ficheiros e os detalhes de fax

Gestão de utilizadores

• fax:use:read

  - Ver os detalhes do utilizador atual (proprietário do PAT)

• fax:user:edit

   - Atualizar os 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 os detalhes da conta e dos membros

• fax:member:edit

  - Gerir as 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

Boas práticas de segurança

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

Sugestões de implementação

1. Seleção de âmbitos

   • Para operações só de leitura, utilize os 

     *:read

      âmbitos

   • Para uma gestão completa, utilize os 

     *:edit

      âmbitos

   • Considere utilizar 

     fax:all:read

     ou 

     fax:all:edit

      para necessidades de acesso abrangente

2. Testes
   • Teste primeiro a sua integração com o mínimo de âmbitos
   • Adicione gradualmente âmbitos conforme necessário
   • Verifique o tratamento da expiração dos tokens na sua aplicação

Resolução de problemas

Se tiver problemas de acesso:

1. Verifique se o token não expirou
2. Confirme que 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

Os Personal Access Tokens são atualmente geridos por utilizador: cada membro da equipa cria e revoga os seus próprios tokens em Definições > Integrações > Personal Access Tokens. Atualmente, não existe nenhum controlo de administração em regime de autosserviço para revogar ou desativar PATs de outros membros da conta.