Estato
Estato

DOMUS - REST API


PROPIETARIOS

Consulta General

Función que muestra todos los propietarios disponibles
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "http://api.domus.la/propietarios",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "authorization: TOKEN_INGRESO",
    ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
                                
{
  "total": 2266,
  "per_page": 10,
  "current_page": 1,
  "last_page": 227,
  "next_page_url": "http://api.domus.la/propietarios/?page=2",
  "prev_page_url": null,
  "from": 1,
  "to": 10,
  "data": [
    {
      "code": 123456,
      "document_id": 0,
      "verification_id": 0,
      "document_type": 1,
      "names": "Propertary",
      "last_names": "",
      "email": "",
      "city": 76001,
      "user": 1,
      "branch": 50,
      "phones": [
        {
          "number": "123456789",
          "phone_type": "House"
        }
      ]
    }
  ]
}
                                
Por Header

Parametro Descripcion Ejemplo
Authorization Token : Llave de acceso 'authorization' => 'TOKEN_AUTENTICACION'

Consulta de un Propietario

Función que muestra toda la información general de un asesor específico por su cédula.
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => "http://api.domus.la/propietarios/123456",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "authorization: TOKEN_INGRESO",
    ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
    echo "cURL Error #:" . $err;
} else {
    echo $response;
}
                                
{
  "data": [
    {
      "code": 711173,
      "document_id": 123456789,
      "verification_id": 0,
      "document_type": 1,
      "names": "Example",
      "last_names": "Example",
      "email": "example@example.com",
      "city": 11001,
      "user": 695,
      "branch": 620,
      "phones": [
        {
          "number": "8536824",
          "phone_type": "House"
        },
        {
          "number": "199999",
          "phone_type": "Fax"
        },
        {
          "number": "321622667",
          "phone_type": "Fax"
        },
        {
          "number": "7891011",
          "phone_type": "Other"
        }
      ]
    }
  ]
}
                                
Por Header

Parametro Descripcion Ejemplo
Authorization Token : Llave de acceso 'authorization' => 'TOKEN_AUTENTICACION'
Por URL

Parametro Descripcion Ejemplo
Cédula Cédula del propietario api.domus.la/propietarios/12345

Inserción de Propietarios

A través de este método se insertan todos los propietarios necesarios en la plataforma de Domus. Si se envía el parámetro que recibe, entonces debe ser enviado obligatoriamente.
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "http://api.domus.la/propietarios",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "codpro=12345&zone=3...",
  CURLOPT_HTTPHEADER => array(
    "authorization: TOKEN_INGRESO",
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
                                
{
  "data": [
    {
      "code": 711176,
      "document_id": 9876576,
      "verification_id": 0,
      "document_type": 1,
      "names": "Example Name",
      "last_names": "Example Last Name",
      "email": "email@example.com",
      "city": 11001,
      "user": 695,
      "branch": 620,
      "phones": [
        {
          "number": "123452",
          "phone_type": "House"
        },
        {
          "number": "123459",
          "phone_type": "Office"
        },
        {
          "number": "123457",
          "phone_type": "Mobil Phone"
        },
        {
          "number": "123458",
          "phone_type": "Fax"
        },
        {
          "number": "123450",
          "phone_type": "Other"
        }
      ]
    }
  ]
}
                            
Por Header

Parametro Descripcion Ejemplo
Authorization Token : Llave de acceso 'authorization' => 'TOKEN_AUTENTICACION'
Por Petición

Parametro Descripcion Ejemplo
document_id * Es el documento de identidad del propietario 'document_id' => '12345'
document_type * Es el tipo de documento del propietario &document_type=1
names * Corresponde a los nombres del propietario &names=Example Name
last_names * Corresponde a los apellidos del propietario &address=Example Last Name
email * Corresponde al correo del propietario &email=email@example.com
city * Corresponde a la ciudad del propietario &type=1
mobil_phone1 - mobil_phone2 Corresponde a los teléfonos de celular del propietario (Hasta 2) &mobil_phone1=12345
house_phone1 - house_phone2 Corresponde a los teléfonos fijos del propietario (Hasta 2) &house_phone1=12345
fax1 - fax2 Corresponde a los numeros de fax pertenecientes a un propietario (Hasta 2) &fax1=12345
office_phone1 - office_phone2 Corresponde a los numeros de oficina pertenecientes a un propietario (Hasta 2) &office_phone2=12345
other_phone1 - other_phone2 Corresponde a los otros numeros de teléfono no clasificados pertenecientes a un propietario (Hasta 2) &other_phone1=12345

Actualización de Propietarios

Permite actualizar todo un propietario específico por su cédula
$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "http://api.domus.la/propietarios/12345",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => "zone=3&description=SomeDescription...",
  CURLOPT_HTTPHEADER => array(
    "authorization: TOKEN_INGRESO",
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
                                
{
  "data": [
    {
      "code": 711176,
      "document_id": 9876576,
      "verification_id": 0,
      "document_type": 1,
      "names": "Example Name",
      "last_names": "Example Last Name",
      "email": "email@example.com",
      "city": 11001,
      "user": 695,
      "branch": 620,
      "phones": [
        {
          "number": "123452",
          "phone_type": "House"
        },
        {
          "number": "123459",
          "phone_type": "Office"
        },
        {
          "number": "123457",
          "phone_type": "Mobil Phone"
        },
        {
          "number": "123458",
          "phone_type": "Fax"
        },
        {
          "number": "123450",
          "phone_type": "Other"
        }
      ]
    }
  ]
}
                            
Por Header

Parametro Descripcion Ejemplo
Authorization Token : Llave de acceso 'authorization' => 'TOKEN_AUTENTICACION'
Por URL

Parametro Descripcion Ejemplo
Cédula Número de Identificación del propietario api.domus.la/123456
Por Petición

Parametro Descripcion Ejemplo
document_id * Es el documento de identidad del propietario 'document_id' => '12345'
document_type * Es el tipo de documento del propietario &document_type=1
names * Corresponde a los nombres del propietario &names=Example Name
last_names * Corresponde a los apellidos del propietario &address=Example Last Name
email * Corresponde al correo del propietario &email=email@example.com
city * Corresponde a la ciudad del propietario &type=1
mobil_phone Corresponde al número de celular del propietario, comienza con su número actual, seguido una coma (,) y luego el número nuevo. Si solo se envía un número que no existe, este se creará &mobil_phone=12345,45678
house_phone Corresponde al número de teléfono fijo del propietario, comienza con su número actual, seguido una coma (,) y luego el número nuevo. Si solo se envía un número que no existe, este se creará &house_phone=12345, 45678
fax Corresponde al número de fax del propietario, comienza con su número actual, seguido una coma (,) y luego el número nuevo. Si solo se envía un número que no existe, este se creará &fax=12345,45678
office_phone Corresponde al número de teléfono de la oficina del propietario, comienza con su número actual, seguido una coma (,) y luego el número nuevo. Si solo se envía un número que no existe, este se creará &office_phone=12345,45678
other_phone Corresponde al otro número de teléfono no clasificado del propietario, comienza con su número actual, seguido una coma (,) y luego el número nuevo. Si solo se envía un número que no existe, este se creará &other_phone=12345,456778