Creación de documentos


Introducción

Método para crear documentos de inmuebles

Ejemplo de uso

{success} POST: /properties/documents

use GuzzleHttp\Client;

$client = new Client();
$res = $client->request("POST", "{$endpoint}/properties/documents", [
    "headers" => [
        "Authorization" => "TOKEN_INGRESO",
        "Accept" => "application/json",
        "Content-type" => "application/json"
    ],
    "multipart" => [
        [
            "name" => "property_id",
            "contents" => 1,
        ],
        [
            "name" => "name",
            "contents" => "Certificado"
        ],
        [
            "name" => "comments",
            "contents" => "Comentario del documento"
        ],
        [
            "name" => "file",
            "contents" => fopen($filePath, "r")
        ]
    ]
]);

$documento = json_decode($res->getBody(), true);
return $documento;

Ejemplo de respuesta

{
    "code": 200,
    "message": "Archivo guardado con éxito",
    "data": {
        "id": 1,
        "name": "Documento",
        "comments": "Comentario del documento",
        "url": "documento.pdf"
    }
}

Parámetros que recibe

Por Header

Parámetro Descripción Ejemplo
Authorization Token de ingreso e identificador de la inmobiliaria (obligatorio) "Authorization" => "TOKEN_INGRESO"

Por Body (Form params)

Los parámetros en negrilla son obligatorios. Los parámetros en cursiva pueden ser obligatorios de acuerdo a condiciones

Parámetro Descripción Ejemplo
property_id unique_code del inmueble &property_id=123
name Nombre del documento &name=Certificado
comments Comentario sobre el documento &comments=Comentario del documento
file Archivo a subir, formatos soportados: jpeg,jpg,png,gif,webp,pdf,doc,docx,ppt,pptx, máximo 20MB &file=fopen...