API Wasi

# Clientes

# Obtener todos los clientes

Para obtener el listado de todos los clientes en Wasi, cuentas con la URI:

api.wasi.co/v1/client/search

Esto debería retornar un JSON similar a este:

{
    "total":2,
    "0": {
        "id_client": 1,
        "id_user": "1",
        "client_types": [
            {
                "id_client_type": 7,
                "client_type_label": "Buscando"
            }
        ],
        "id_country": "1",
        "country_label": "Colombia",
        "id_region": "26",
        "region_label": "Quindío",
        "id_city": "63",
        "city_label": "Armenia",
        "id_client_status": "1",
        "id_client_origin": 124,
        "client_origin_label": "Portal Inmobliario",
        "first_name": "Pepito",
        "last_name": "Perez",
        "birthday": "1980-12-12",
        "identification": "11111111111",
        "email": "[email protected]",
        "phone": "11111111",
        "cell_phone": "31111111111111",
        "address": "Calle 1 # 1-11",
        "query": "",
        "comment": "",
        "reference": "",
        "send_information": true,
        "created_at": "2017-02-09 09:02:40",
        "updated_at": "0000-00-00 00:00:00",
        "tag": [
            {
                "id": 20,
                    "etiqueta": "Nuevo Cliente",
                    "color": "#eee"
            }
        ],
    },
    "1": {
        "id_client": 2,
        "id_user": "1",
        "client_types": [
            {
                "id_client_type": 7,
                "client_type_label": "Buscando"
            }
        ],
        "id_country": "1",
        "country_label": "Colombia",
        "id_region": "26",
        "region_label": "Quindío",
        "id_city": "63",
        "city_label": "Armenia",
        "id_client_status": "1",
        "id_client_origin": null,
        "client_origin_label": "",
        "first_name": "John",
        "last_name": "Doe",
        "birthday": "1955-12-12",
        "identification": "21111111111",
        "email": "[email protected]",
        "phone": "21111111",
        "cell_phone": "3211111111111",
        "address": "Calle 2 # 1-11",
        "query": "",
        "comment": "",
        "reference": "",
        "send_information": true,
        "created_at": "2017-02-09 09:02:40",
        "updated_at": "0000-00-00 00:00:00",
        "tag": []
    },
    "status":"success"
}

# Filtrado

Los filtros son opcionales, a continuación se listan los filtros exitentes para la búsqueda de clientes.

Filtro Tipo Detalle
query String Palabras claves para realizar una busqueda.
id_property Number Id de una propiedad a la que pertenezca el cliente.
id_client_type Number Id de un tipo de cliente, ver la sección Tipos de cliente
id_client_status Number Identificador del estado del cliente, ver la sección Estados del cliente
id_client_origin Number Identificador del medio de captación del cliente, ver la sección Medios de captación
id_user Number Identificador unico del usuario (agente o administrador) encargado.

# Paginación y ordenamiento

Filtro Tipo
skip Number Offset, indica desde donde se muestran los registros, 0 por defecto (desde el inicio, sin omitir ninguno).
take Number Limit, cantidad de elementos a listar, 10 por defecto (100 como máximo).
order String Puede tomar dos valores asc (Ascendente) y desc (Descendente), asc por omisión.
order_by String Ordena por una criterio en específico, full_name por omisión ver order_by.

# order_by

Valor Descripción
full_name Ordena los clientes por nombre completo.
created_at Ordena los clientes por fecha de registro.

# Obtener un cliente

Para obtener un cliente en Wasi, cuentas con la URI:

api.wasi.co/v1/client/get/#id_client

Para un cliente de ejemplo cuyo id_client es 1, la URI sería:

api.wasi.co/v1/client/get/1

Esto debería retornar un JSON similar a este:

{
    "id_client": 21,
    "id_user": 9,
    "client_types": [
        {
            "id_client_type": 7,
            "client_type_label": "Buscando"
        }
    ],
    "id_country": 1,
    "country_label": "Colombia",
    "id_region": 26,
    "region_label": "Quind\u00edo",
    "id_city": 63,
    "city_label": "Armenia",
    "id_client_status": 1,
    "id_client_origin": null,
    "client_origin_label": "",
    "first_name": "Jose",
    "last_name": "Capera",
    "birthday": "1991-12-19",
    "identificacion": "1094123123",
    "email": "[email protected]",
    "phone": "7400000",
    "cell_phone": "3001231234",
    "address": "Calle 12A #12-34",
    "query": "",
    "comment": "Interesado en el negocio",
    "reference": "",
    "send_information": true,
    "created_at": "2016-12-11 17:12:12",
    "updated_at": "2017-02-09 12:23:08",
    "tag": [
        {
            "id": 20,
            "etiqueta": "Nuevo Cliente",
            "color": "#eee"
        }
    ],
    "status": "success"
}

# Agregar un Cliente

Para agregar un nuevo cliente en Wasi, cuentas con la URI:

api.wasi.co/v1/client/add

Despues de enviar los parametros correctamente deberia devolver un JSON como el siguiente:

{
    "id_client": 123456,
    "status": "success"
}

❗️ Importante

La solicitud solo puede enviarse via POST, asi como es de recordar que para todas las peticiones también es necesario envíar las credenciales de acceso, ver Credenciales de acceso.

# Actualizar cliente

Para actualizar un cliente en Wasi, cuentas con la URI:

api.wasi.co/v1/client/update/#id_client

Para un cliente de ejemplo cuyo id_client es 1, la URI sería:

api.wasi.co/v1/client/update/1

Para saber cuales son los campos que se pueden actualizar se puede ver la sección Campos de los clientes, los campos que podemos envíar como parámetro en la tabla deben figurar como modificables.

Por ejemplo si se desea actualizar el teléfono del cliente con id_client 3, debe hacer lo siguiente:

api.wasi.co/v1/client/update/3?phone=000000000

Deberia devolver un JSON como el siguiente:

{
    "status": "success"
}

❗️ Importante

Los parametros a modificar pueden enviarse via GET o via POST, asi como es de recordar que para todas las peticiones también es necesario envíar las credenciales de acceso, ver Credenciales de acceso.

# Tipos de cliente

Para los tipos de cliente se cuentan con algunos valores estándar publicos que puede tomar el cliente client_types (también existen valores privados que son los personalizados por cada empresa) los valores publicos son:

Para obtener el listado de todos los tipos de cliente soportados por Wasi y los personalizados por la empresa se debe usar la URI:

api.wasi.co/v1/client-type/all

Esto debería retornar un JSON similar al siguiente:

{
    "0": {
        "id_client_type": 1,
        "name": "Comprador",
        "nombre": "Comprador",
        "public": true
    },
    "1": {
        "id_client_type": 2,
        "name": "Vendedor",
        "nombre": "Vendedor",
        "public": true
    },
    "2": {
        "id_client_type": 3,
        "name": "Arrendador",
        "nombre": "Arrendador",
        "public": true
    },
    "3": {
        "id_client_type": 4,
        "name": "Arrendatario",
        "nombre": "Arrendatario",
        "public": true
    },
    "4": {
        "id_client_type": 5,
        "name": "Propietario",
        "nombre": "Propietario",
        "public": true
    },
    "5": {
        "id_client_type": 6,
        "name": "Comisionista",
        "nombre": "Comisionista",
        "public": true
    },
    "6": {
        "id_client_type": 7,
        "name": "Buscando",
        "nombre": "Buscando",
        "public": true
    },
    "7": {
        "id_client_type": 8,
        "name": "Contacto Web",
        "nombre": "Contacto Web",
        "public": true
    },
    "8": {
        "id_client_type": 9,
        "name": "Codeudor",
        "nombre": "Codeudor",
        "public": true
    },
    "9": {
        "id_client_type": 10,
        "name": "Administrador",
        "nombre": "Administrador",
        "public": true
    },
    "10": {
        "id_client_type": 11,
        "name": "Inquilino",
        "nombre": "Inquilino",
        "public": true
    },
    "11": {
        "id_client_type": 12,
        "name": "Contacto Importado",
        "nombre": "Contacto Importado",
        "public": true
    },
    "12": {
        "id_client_type": 13,
        "name": "Comisionista",
        "nombre": "Comisionista",
        "public": false
    },
    "status": "success"
}

❗️ Importante

Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.

# Medio de captación del cliente

Para los medios de captación de cliente se cuentan con el valores estandar publicos que puede tomar el cliente client_origin (también existen valores privados que son los personalizados por cada empresa) los valores publicos son:

Valor Representa
124 Portal Inmobliario

Para obtener el listado de todos los Medio de captación soportados por Wasi y los personalizados por la empresa se debe usar la URI:

api.wasi.co/v1/client-origin/all

Esto debería retornar un JSON similar al siguiente:

{
    "0": {
    "id_client_origin": 124,
    "name": "Portal Inmobliario",
    "public": true
    },
    "1": {
        "id_client_origin": 125,
        "name": "Directo",
        "public": false
    },
    "2": {
        "id_client_origin": 126,
        "name": "Feria Hogar Corferias 2018",
        "public": false
    },

    "status": "success"
}

❗️ Importante

Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.

# Propiedades

# Relacionar a una propiedad

Puedes relacionar un cliente a una propiedad usando los tipos de clientes tanto publicos como los tipos privados, puedes verlos en la sección Tipos de cliente.

Para relacionar una propiedad con un cliente se cuenta con la siguiente URI:

POST api.wasi.co/v1/client/#id_client/add-property/#id_property

Esta URI tambien requiere el parámetro id_client_type, es decir que si queremos relacionar el cliente con id 1234 a la propiedad 4321 y que el tipo de relación es que dicho cliente sea Propietario (id 5 ver Tipos de cliente), deberiamos usar para esto la URI:

POST http://api.wasi.co/v1/client/1234/add-property/4321?id_client_type=5

Si todo esta en orden, esto debería retornar un JSON similar al siguiente:

{
    "status": "success"
}

# Actualizar el tipo de relacion con una propiedad

Puedes actualizar la relacion de un cliente con una propiedad con la siguiente URI:

POST api.wasi.co/v1/client/#id_client/update-property/#id_property

Esta URI tambien requiere el parámetro id_client_type, es decir que si queremos cambiar la relación del cliente con id 1234 con la propiedad 4321, y que el tipo de relación sea Buscando (id 7 ver Tipos de cliente), deberiamos usar para esto la URI:

POST http://api.wasi.co/v1/client/1234/update-property/4321?id_client_type=7

Si todo esta en orden, esto debería retornar un JSON similar al siguiente:

{
    "status": "success"
}

# Eliminar la relacion con una propiedad

Puedes eliminar la relacion de un cliente con una propiedad se cuenta con la siguiente URI:

POST api.wasi.co/v1/client/#id_client/remove-property/#id_property

Si queremos eliminar la relacionar del cliente con id 1234 con la propiedad 4321 deberiamos usar para esto la URI:

POST http://api.wasi.co/v1/client/1234/remove-property/4321

Si todo esta en orden, esto debería retornar un JSON similar al siguiente:

{
    "status": "success"
}

# Obtener las propiedades relacionadas

Puedes obtener las propiedades asociados a un cliente con la siguiente URI:

api.wasi.co/v1/client/properties/#id_client

Si todo esta en orden, esto debería retornar un JSON similar al siguiente:

{
    "0": {
        "id_property": 1234,
        "title": "Propiedad 1",
        "id_client_type": 5,
        "client_type_label": "Propietario"
    },
    "1": {
        "id_property": 1235,
        "title": "Propiedad 2",
        "id_client_type": 1,
        "client_type_label": "Comprador"
    },
    "total": 2,
    "status": "success"
}

# Filtrado

Los filtros son opcionales, a continuación se listan los filtros exitentes para la búsqueda de propiedades.

Filtro Tipo Detalle
id_client_type Number Id del tipo de cliente, ver Tipos de cliente.

# Paginación

Filtro Tipo
skip Number Offset, indica desde donde se muestran los registros, 0 por defecto (desde el inicio, sin omitir ninguno).
take Number Limit, cantidad de elementos a listar, 10 por defecto (100 como máximo).

❗️ Importante

Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.

# Contacto

Puede generar el contacto de un cliente mediante la URI:

api.wasi.co/v1/client/contact

Si todo esta en orden, esto debería retornar un JSON similar al siguiente:

{
    "id_client": 123,
    "new_client": false,
    "status": "success"
}

❗️ Nota

El valor retornado new_client indica si con el contacto se creó un usuario nuevo.

# Parámetros

Los parámetros para el envío del contacto son los siguientes.

Parámetro Tipo Obligatorio Descripción
email String Sí Email del cliente que hace el contacto.
first_name String Sí Nombre del cliente.
last_name String No Apellido del cliente.
phone Number Sí Número de teléfono.
id_country Number Sí Id de un país, ver Paises.
id_region Number Sí Id de una región, ver Regiones.
id_city Number Sí Id de una ciudad, ver Ciudades.
comment String No Comentarios del cliente.
send_information Boolean No Valor booleano (true o false) que indica si el cliente desea recibir información al email.
id_property Number No Identificador unico de una propiedad.
id_client_type Number No Identificador que indica el tipo de cliente, ver la sección Tipos de cliente.

❗️ Nota

Si se envía el parámetro id_property el cliente quedará asociado al inmueble. Si adicional a id_property se envia send_information con valor true, se le enviará al cliente un email con la información del inmueble indicado.

❗️ Importante

Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.

# Ofertar

Puede generar la oferta de un cliente mediante la URI:

api.wasi.co/v1/client/offer

Si todo esta en orden, esto debería retornar un JSON similar al siguiente:

{
    "status": "success"
}

# Parámetros

Los parámetros para el envío de la oferta son los siguientes.

Parámetro Tipo Obligatorio Descripción
email String Sí Email del cliente que hace la oferta.
first_name String Sí Nombre del cliente.
last_name String No Apellido del cliente.
phone Number Sí Número de teléfono.
id_country Number Sí Id de un país, ver Paises.
id_region Number Sí Id de una región, ver Regiones.
id_city Number Sí Id de una ciudad, ver Ciudades.
comment String No Comentarios del cliente.
send_information Boolean No Valor booleano (true o false) que indica si el cliente desea recibir información al email.

❗️ Importante

Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.

# Enviar a un amigo

Puede generar el envio de una propiedad recomendada a un amigo mediante la URI:

api.wasi.co/v1/client/contact-friend

Si todo esta en orden, esto debería retornar un JSON similar al siguiente:

{
   "id_client": 123,
    "new_client": false,
    "status": "success"
}

❗️ Nota

El valor retornado new_client indica si con el contacto se creó un usuario nuevo.

# Parámetros

Los parámetros para el envío a un amigo son los siguientes.

Parámetro Tipo Obligatorio Descripción
email String Sí Email del contacto al que se envia el mensaje.
first_name String Sí Nombre del contacto al que se envia el mensaje.
last_name String No Apellido del contacto al que se envia el mensaje.
phone Number No Número del contacto al que se envia el mensaje
id_country Number No Id de un país, ver Paises.
id_region Number No Id de una región, ver Regiones.
id_city Number No Id de una ciudad, ver Ciudades.
from_name String Sí Nombre de la persona que envia el mensaje.
comment String No Texto que se envia en el mensaje.
id_property Number Sí Identificador unico de una propiedad.

❗️ Nota

Si se envía el parámetro id_property el cliente quedará asociado al inmueble. Si adicional a id_property se envia send_information con valor true, se le enviará al cliente un email con la información del inmueble indicado.

❗️ Importante

Para todas las peticiones es necesario el envío de credenciales, para más información puedes visitar la sección de Primeros pasos.

Last Updated: 8/3/2020, 9:51:52 PM

← Agenda →