¿Quién puede usar esta característica?
Disponible enEnterprise plan.
Accesible a los propietarios y administradores de la aplicación web.
Para utilizar la API del archivo .Plus, primero debes conceder autorización para que la API acceda a tu cuenta. Después de completar el proceso de autorización, puede iniciar sesión en su cuenta.
Hay dos métodos diferentes para la autenticación:
- Generar y utilizar tokens de acceso personal.
- Utilice el flujo OAuth 2.0.
A Personal Access Token can be used as an authentication method to access the Fax.Plus API securely. Este token sirve como firma digital, permitiéndote hacer solicitudes autorizadas a nuestra API, habilitando acciones tales como enviar faxes y recuperar datos a sus faxes.
Sigue estos pasos para generar un nuevo token de acceso personal:
- Inicia sesión en tu cuenta .Plus , y ve a la sección Perfilen tu panel de control.
- Encuentra la pestaña para Integraciones.
- Under Fax.Plus API, find the item for Personal Access Tokens, and click on Manage.
- Haga clic en Generar tokeny especifique el nombre token, fecha de caducidady alcances (ambos editan y leen como alcances en el token).
- Make sure to Copy your Personal Access Token now, otherwise you won't be able to see it again.
Paso 1: Configurar flujo inicial de autenticación
- Inicia sesión en tu cuenta .Plus , y ve a la sección Perfilen tu panel de control.
- Encuentra la pestaña para Integraciones.
- Debajo de .Plus API, haga clic en Activary recopilar los siguientes datos:
- ID de cliente (comienza con APIK-)
- Secreto del cliente
- Redirigir 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 utilizando un navegador web. Este enlace te redirigirá a un prompt donde puedes otorgar los permisos necesarios: https://accounts.fax. lus/login?response_type=code&client_id=[client ID]&redirect_uri=[redirect URI]&scope=all
-
Una vez concedido el permiso, se le enviará a la URL que ha especificado, acompañada del código de autorización como parámetro URL:
Paso 2: Enviar una solicitud HTTP POST
Después de que hayas autorizado con éxito, puedes proceder a realizar un POST HTTP a la siguiente URL: https://accounts.fax. lus/token?grant_type=authorization_code&client_id=[ID del cliente]&code=[código de autorización]&redirect_uri=[URL de redirección].
asegúrese de incluir los siguientes encabezados en su petición:
-
- Content-Type: application/x-www-form-urlencoded
- Autorización: Cadena básica [base64 codificada de "client_id:client_secret"]
- Content-Type: application/x-www-form-urlencoded
Una vez completado, recibirá una respuesta que contenga un token de acceso, que permanece válida por 1 hora, así como un token de actualización con validez indefinida.
Nota: Si tu Fax. lus cuenta ha activado Advanced Security Control, el token de actualización sigue siendo válido durante 30 días de acuerdo con las normas de seguridad. Esto implica que usted necesitará repetir el proceso cada 30 días para obtener un token de actualización fresco.
Paso 3: Obtener nuevo token de acceso
Una vez que tu token de acceso ha caducado, puedes obtener uno fresco usando tu token de actualización a través de una solicitud HTTP POST a la siguiente URL: https://accounts. ax. lus/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
- Autorización: Cadena básica [base64 codificada de "client_id:client_secret"]
Después de obtener el token de acceso, todas las llamadas API posteriores requerirán las siguientes cabeceras:
-
- Autorización: portador [token de acceso]
- x-fax-clientid: [ID del cliente]