Crear usuario

Permite crear un nuevo usuario en Factal asociado al partner autenticado.

Una vez creado, el usuario podrá acceder a Factal utilizando el servicio Obtener URL de acceso.

Endpoint

POST /partners/users

Cabeceras

Todas las peticiones deberán incluir las siguientes cabeceras:

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

Cuerpo de la petición

{
  "name": "nombre usuario",
  "email": "email_usuario@email.com"
}

Parámetros

name

Nombre del usuario que se creará en Factal.

Obligatorio:

email

Dirección de correo electrónico del usuario.

Debe ser única dentro de Factal.

Obligatorio:


Respuesta

Si el usuario se crea correctamente, la API responderá con el código 201 Created.

{
  "code": 201,
  "status": "OK",
  "message": "OK",
  "data": {
    "user": {
      "id": "2073de05-76f4-47a8-a35d-dd73f14e4320",
      "name": "nombre usuario",
      "email": "email_usuario@email.com"
    }
  }
}

user

Información del usuario creado.

  • id: Identificador único del usuario. Será necesario para solicitar posteriormente una URL de acceso.
  • name: Nombre del usuario.
  • email: Dirección de correo electrónico.

Errores

400 Bad Request

La petición contiene datos incorrectos o incompletos.

{
  "code": 400,
  "status": "ERROR",
  "message": "Validation error",
  "data": null
}

401 Unauthorized

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

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

409 Conflict

Ya existe un usuario registrado con esa dirección de correo electrónico.

{
  "code": 409,
  "status": "ERROR",
  "message": "Email already in use",
  "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. Cree el usuario mediante el endpoint POST /partners/users.

  2. Guarde el identificador devuelto en el campo user.id.

  3. Cuando el usuario desee acceder a Factal, solicite una URL de acceso utilizando el servicio Obtener URL de acceso.

  4. Redirija al usuario a la URL recibida para iniciar sesión automáticamente en Factal.