Quem pode utilizar esta funcionalidade?
Disponível no plano Enterprise.
Acessível a Proprietários e Administradores na aplicação Web.
Para utilizar a API do Fax.Plus, deve primeiro conceder autorização para que a API aceda à sua conta. Após concluir o processo de autorização, pode iniciar sessão na sua conta.
Existem dois métodos diferentes de autenticação:
- Gerar e utilizar tokens de acesso pessoal.
- Utilizar o fluxo OAuth 2.0.
Um Token de Acesso Pessoal pode ser utilizado como método de autenticação para aceder à API do Fax.Plus com segurança. Este token funciona como uma assinatura digital, permitindo-lhe efetuar pedidos autorizados à nossa API, possibilitando ações como o envio de faxes e a obtenção de dados dos seus faxes.
Siga estes passos para gerar um novo Token de Acesso Pessoal:
- Inicie sessão na sua conta Fax.Plus e aceda à secção Definições no seu painel.
- Encontre o separador Integrações.
- Em Fax.Plus API, encontre o item Tokens de Acesso Pessoal e clique em Gerir.
- Clique em Gerar Token e especifique o nome do token, a data de validade e os âmbitos (tanto edição como leitura como âmbitos do token).
- Certifique-se de que copia o seu Token de Acesso Pessoal agora, caso contrário não poderá voltar a vê-lo.
Passo 1: Configurar o fluxo de autenticação inicial
- Inicie sessão na sua conta Fax.Plus e aceda à secção Definições no seu painel.
- Encontre o separador Integrações.
- Em Fax.Plus API, clique em Ativar e recolha os seguintes dados:
- Client ID (começa com APIK-)
- Client secret
- Redirect URI (um deles)
- Para iniciar o processo de autorização da API para aceder à sua conta, basta clicar na hiperligação fornecida neste passo utilizando um navegador web. Esta hiperligação irá redirecioná-lo para um ecrã onde poderá conceder as permissões necessárias: https://accounts.fax.plus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all
-
Assim que a permissão for concedida, será direcionado para o URL que especificou, acompanhado do código de autorização como parâmetro do URL:
Passo 2: Enviar um pedido HTTP POST
Depois de ter autorizado o acesso com êxito, pode prosseguir com um pedido HTTP POST para o seguinte URL: https://accounts.fax.plus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
Certifique-se de que inclui os seguintes cabeçalhos no seu pedido:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
Depois de concluído, receberá uma resposta contendo um token de acesso, que permanece válido durante 1 hora, bem como um token de atualização com validade indefinida.
Nota: Se a sua conta Fax.Plus tiver o Advanced Security Control ativado, o token de atualização permanece válido durante 30 dias, em conformidade com os regulamentos de segurança. Isto implica que terá de repetir o processo a cada 30 dias para obter um novo token de atualização.
Passo 3: Obter um novo token de acesso
Assim que o seu token de acesso expirar, pode obter um novo utilizando o seu token de atualização através de um pedido HTTP POST para o seguinte URL: https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=[refresh token].
Este processo requer a inclusão dos seguintes cabeçalhos:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
Depois de obter o token de acesso, todas as chamadas subsequentes à API irão requerer os seguintes cabeçalhos:
-
- Authorization: Bearer [access token]
- x-fax-clientid: [client ID]