Obtener URL de acceso

Genera una URL temporal que permite iniciar sesión automáticamente en Factal para un usuario previamente creado.

La URL devuelta deberá utilizarse para redirigir al usuario a Factal cuando desee acceder a la aplicación.

Endpoint

POST /partners/users/{userId}/access

Cabeceras

Todas las peticiones deberán incluir las siguientes cabeceras:

Content-Type: application/json
x-partner-api-key: <SU_API_KEY>

Parámetros de la ruta

userId

Identificador único del usuario para el que se desea generar la URL de acceso.

El usuario debe pertenecer al partner autenticado.

Obligatorio: Sí

Cuerpo de la petición

Este endpoint no requiere cuerpo de la petición.

Respuesta

Si la URL se genera correctamente, la API responderá con el código 200 OK.

{
  "code": 200,
  "status": "OK",
  "message": "OK",
  "data": {
    "accessUrl": "https://app.factal.es/partner-access?token=..."
  }
}

accessUrl

URL temporal que permite iniciar sesión automáticamente en Factal.

El partner deberá redirigir al usuario a esta dirección cuando desee acceder a la aplicación.

Importante

La URL de acceso es de un solo uso y tiene una validez limitada. Deberá solicitarse una nueva URL cada vez que el usuario desee acceder a Factal.

Errores

401 Unauthorized

La API Key no existe, es incorrecta o el partner no está autorizado.

{
  "code": 401,
  "status": "ERROR",
  "message": "Unauthorized",
  "data": null
}

404 Not Found

No existe ningún usuario con el identificador indicado o el usuario no pertenece al partner autenticado.

{
  "code": 404,
  "status": "ERROR",
  "message": "User not found",
  "data": null
}

500 Internal Server Error

Se ha producido un error interno al procesar la petición.

{
  "code": 500,
  "status": "ERROR",
  "message": "Internal server error",
  "data": null
}

Flujo de integración

1. Solicita una URL de acceso mediante el endpoint POST /partners/users/{userId}/access.

2. Obtén la URL devuelta en el campo accessUrl.

3. Redirige al usuario a dicha dirección.

4. Factal iniciará automáticamente la sesión del usuario.