¿Quién puede usar esta función?
Disponible en el plan Enterprise.
Accesible para Propietarios y Administradores en la aplicación web.
Para usar la API de Fax.Plus, primero debe otorgar autorización para que la API acceda a su cuenta. Después de completar el proceso de autorización, podrá iniciar sesión en su cuenta.
Existen dos métodos diferentes para la autenticación:
- Genere y utilice tokens de acceso personal.
- Utilice el flujo de OAuth 2.0.
Un Token de acceso personal se puede utilizar como método de autenticación para acceder de forma segura a la API de Fax.Plus. Este token funciona como una firma digital, lo que le permite realizar solicitudes autorizadas a nuestra API, habilitando acciones como el envío de faxes y la recuperación de datos de sus faxes.
Siga estos pasos para generar un nuevo Token de acceso personal:
- Inicie sesión en su cuenta de Fax.Plus y vaya a la sección de Configuración en su panel de control.
- Busque la pestaña Integraciones.
- En Fax.Plus API, busque el elemento Tokens de acceso personal y haga clic en Gestionar.
- Haga clic en Generar token y especifique el nombre del token, la fecha de caducidad y los alcances (scopes) (tanto edit como read como alcances del token).
- Asegúrese de hacer clic en Copiar para copiar su Token de acceso personal ahora, ya que no podrá volver a verlo.
Paso 1: Configurar el flujo de autenticación inicial
- Inicie sesión en su cuenta de Fax.Plus y vaya a la sección de Configuración en su panel de control.
- Busque la pestaña Integraciones.
- En Fax.Plus API, haga clic en Activar y recopile los siguientes datos:
- Client ID (comienza con APIK-)
- Client secret
- Redirect URI (uno de ellos)
- Para iniciar el proceso de autorización de la API para acceder a su cuenta, simplemente haga clic en el enlace proporcionado en este paso usando un navegador web. Este enlace le redirigirá a una pantalla donde podrá conceder los permisos necesarios: https://accounts.fax.plus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all
-
Una vez concedido el permiso, será dirigido a la URL que especificó, acompañado del código de autorización como parámetro de la URL:
Paso 2: Enviar una solicitud HTTP POST
Después de haber autorizado el acceso correctamente, puede proceder a realizar un HTTP POST a la siguiente URL: https://accounts.fax.plus/token?grant_type=authorization_code&client_id=[client ID]&code=[authorization code]&redirect_uri=[redirect URI].
Asegúrese de incluir los siguientes encabezados en su solicitud:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
Una vez completado, recibirá una respuesta que contiene un token de acceso, válido durante 1 hora, así como un token de actualización (refresh token) con validez indefinida.
Nota: Si su cuenta de Fax.Plus tiene activado Advanced Security Control, el token de actualización permanece válido durante 30 días de acuerdo con las normativas de seguridad. Esto implica que deberá repetir el proceso cada 30 días para obtener un nuevo token de actualización.
Paso 3: Obtener un nuevo token de acceso
Una vez que su token de acceso haya caducado, puede obtener uno nuevo utilizando su token de actualización mediante una solicitud HTTP POST a la siguiente URL: https://accounts.fax.plus/token?grant_type=refresh_token&refresh_token=[refresh token].
Este proceso requiere la inclusión de los siguientes encabezados:
-
- Content-Type: application/x-www-form-urlencoded
- Authorization: Basic [base64-encoded string of "client_id:client_secret"]
Después de obtener el token de acceso, todas las llamadas posteriores a la API requerirán los siguientes encabezados:
-
- Authorization: Bearer [access token]
- x-fax-clientid: [client ID]