Quem pode usar este recurso?
Disponível no planoEnterprise .
Acessível aos Proprietários e Administradores no Aplicativo Web.
Para usar a API do Fax.Plus, você deve primeiro conceder autorização para a API acessar sua conta. Depois de concluir o processo de autorização, você pode acessar a sua conta.
Existem dois métodos diferentes para autenticação:
- Gere e use tokens de acesso pessoais.
- Use o fluxo OAuth 2.0.
Um Token de Acesso Pessoal pode ser usado como um método de autenticação para acessar com segurança a API Fax.Plus. Esse token serve como uma assinatura digital, permitindo que você faça solicitações autorizadas para nossa API, permitir ações, como enviar faxes e recuperar dados para seus faxes.
Siga estes passos para gerar um novo Token de Acesso Pessoal:
- Faça login na sua conta Fax.Plus e vá para a seção Perfilno seu painel.
- Encontre a guia para Integrações .
- Em Fax.Plus API, encontre o item para Token de Acesso Pessoale clique em Gerenciar.
- Click on Generate Token and specify the token name, expiration date, and scopes (both edit and read as scopes on the token).
- Make sure to Copy your Personal Access Token now, otherwise you won't be able to see it again.
Passo 1: Configurar o fluxo inicial da autenticação
- Faça login na sua conta Fax.Plus e vá para a seção Perfilno seu painel.
- Encontre a guia para Integrações .
- Em Fax.Plus API, clique em ativare colete os seguintes dados:
- ID do cliente (começa com APIK-)
- Segredo do cliente
- Redirecionar URI (um deles)
- Para iniciar o processo de autorização da API para acessar a sua conta, basta clicar no link fornecido neste passo usando um navegador web. Este link irá redirecioná-lo para um prompt onde você pode conceder as permissões necessárias: https://accounts.fax. lus/login?response_type=código&cliente_id=[ID do cliente]&redirect_uri=[URI de redirecionamento]&escopo=all
-
Uma vez concedida a permissão, você será direcionado para o URL que você especificou, acompanhado pelo código de autorização como um parâmetro URL:
Passo 2: Enviar uma solicitação HTTP POST
Após ter autorizado o acesso com sucesso, você pode prosseguir para executar um POST HTTP na seguinte URL: https://accounts.fax. lus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
Não se esqueça de incluir os seguintes cabeçalhos na sua solicitação:
-
- Content-Type: application/x-www-form-urlencoded
- Autorização: Básico [string codificada em base64 de "cliente_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
Uma vez concluído, você receberá uma resposta contendo um token de acesso, que permanece válido por 1 hora, bem como um token de atualização com validade indefinida.
Nota: Se sua Fax. Conta lus tem Controle de Segurança Avançado ativado, o token de atualização permanece válido por 30 dias de acordo com as normas de segurança. Isso implica que você precisará repetir o processo a cada 30 dias para obter um novo token de atualização.
Passo 3: Obter novo token de acesso
Uma vez expirado o seu token de acesso, você pode obter um novo usando seu token de atualização através de uma solicitação HTTP POST para a seguinte URL: https://accounts. machado. lus/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
- Autorização: Básico [string codificada em base64 de "cliente_id:client_secret"]
Após a obtenção do token de acesso, todas as chamadas de API subsequentes exigirão os seguintes cabeçalhos:
-
- Autorização: Cuidado [token de acesso]
- x-fax-clientid: [ID do cliente]