API : Clientes

https://www.obuma.cl/ayuda/articulo/156


API Endpoint: Clientes

 

Listar Clientes

  • URL: /clientes.list.json
  • Método: GET
  • Descripción: Obtiene una lista de todos los clientes de la empresa.
  • Parámetros (opcional, para filtrar y hacer busquedas ):
    • id: Filtra por ID del cliente.
    • cliente_rut: Filtra por RUT del cliente.
    • cliente_extranjero: Filtra por condición de extranjero.
    • cliente_extranjero_id: Filtra por ID extranjero.
    • cliente_razon_social: Filtra por razón social (búsqueda parcial).
    • cliente_email: Filtra por email del cliente.
    • cliente_clave: Filtra por clave del cliente.
    • estado: Filtra por estado del cliente (activo/inactivo).

 

Obtener Cliente por ID

  • URL: /clientes.findById.json/{RecursoId}
  • Método: GET
  • Descripción: Devuelve un cliente específico basado en el ID proporcionado.
  • Parámetros:
    • RecursoId: ID del cliente (incluido en la URL).

 

Obtener Cliente por RUT

  • URL: /clientes.findByRut.json/{RecursoId}
  • Método: GET
  • Descripción: Devuelve un cliente específico basado en el RUT proporcionado.
  • Parámetros:
    • RecursoId: RUT del cliente (incluido en la URL).

 

Obtener Cliente por Extranjero ID

  • URL: /clientes.findByExtranjeroId.json/{RecursoId}
  • Método: GET
  • Descripción: Devuelve un cliente específico basado en el ID de extranjero proporcionado.
  • Parámetros:
    • RecursoId: ID extranjero del cliente (incluido en la URL).

 

Crear Cliente

  • URL: /clientes.create.json
  • Método: POST
  • Descripción: Crea un nuevo cliente con los datos proporcionados.
  • Body (JSON):
    • cliente_rut: RUT del cliente.
    • cliente_razon_social: Razón social del cliente.
    • cliente_email: Email del cliente.
    • cliente_clave: Clave del cliente.
    • Otros datos relevantes del cliente según sea necesario.

 

Actualizar Cliente

  • URL: /clientes.update.json
  • Método: POST
  • Descripción: Actualiza un cliente existente con los nuevos datos proporcionados.
  • Parámetros:
    • RecursoId: ID del cliente (incluido en la URL).
  • Body (JSON):
    • cliente_rut: RUT del cliente.
    • cliente_razon_social: Razón social del cliente.
    • cliente_email: Email del cliente.
    • cliente_clave: Clave del cliente.
    • cliente_id: (Obligatorio) ID del cliente.
    • Otros datos relevantes que se deseen actualizar.

 

Actualizar Clave del Cliente

  • URL: /clientes.updateClave.json
  • Método: POST
  • Descripción: Actualiza la clave de un cliente.
  • Body (JSON):
    • cliente_id: ID del cliente.
    • clave_nueva: (Opcional) Nueva clave del cliente, sistema se encarga de encriptarla. Si no se proporciona, se generará una clave nueva automáticamente.