Cadastrar empreendimento - Homfy Public API

Cadastra um empreendimento — o condomínio, o prédio ou o loteamento a que os imóveis pertencem. Reexecutável: reenviar o mesmo partner_code devolve o empreendimento já existente em skipped, sem criar outro e sem atualizar nada. Para alterar, use PUT /partner/v1/realty-cluster.

Só partner_code, name e type são obrigatórios. O empreendimento nasce ATIVO.

O endereço decide o code. O código da Homfy (E-SC0042) é gerado a partir da UF, na primeira vez que o empreendimento tiver endereço, e não muda depois. Sem endereço, code volta vazio — o que é válido, mas deixa o empreendimento sem a identificação que as telas da imobiliária usam.

A resposta 201 pode conter falha: confira errors antes de dar o cadastro por concluído. Há um caso particular: se o empreendimento for criado e o endereço não puder ser gravado, o item aparece em errors e o empreendimento EXISTE, sem endereço — repetir a carga o encontra em skipped, e completar o cadastro é trabalho do PUT.

As comodidades do condomínio (piscina, portaria 24h, salão de festas) não fazem parte deste contrato — quem precisa delas as cadastra no painel, e nada do que a API grava é apagado por isso.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "type": "Empreendimento",
    "partner_code": "EMP-1024",
    "name": "Residencial Bela Vista",
    "is_active": true,
    "description": "Condomínio fechado com 4 torres, entregue em 2019.",
    "email": "contato@belavista.com.br",
    "phone": "(48) 3333-4444",
    "whatsapp": "48999998888",
    "address": {
        "state": "SC",
        "zipcode": "88015-600",
        "city": "Florianópolis",
        "district": "Centro",
        "street": "Bocaiúva",
        "street_number": "120",
        "street_type": "Rua",
        "reference": "Próximo ao mercado",
        "complement": "Apto 302",
        "block": "Torre B",
        "latitude": "-27.593500",
        "longitude": "-48.548500"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201

application/json

Empreendimento criado, ou já existente em skipped. Os errorCode possíveis dentro de errors[]: PARTNER_REALTY_CLUSTER_INCOMPLETE (foi criado, mas o endereço não entrou — complete pelo PUT, e NÃO recadastre), PARTNER_REALTY_CLUSTER_ALREADY_EXISTS (outra chamada sua criou o mesmo código no mesmo instante — consulte, não recrie) e PARTNER_REALTY_CLUSTER_REGISTER_FAILED (falha da Homfy — repita).

Bodyapplication/json

Example

{
    "created": [
        {
            "partner_code": "AP-1024",
            "realty_cluster_id": 42,
            "code": "SC1547"
        }
    ],
    "skipped": [
        {
            "partner_code": "AP-1024",
            "realty_cluster_id": 42
        }
    ],
    "errors": [
        {
            "partner_code": "AP-1024",
            "errorCode": "PARTNER_PROPERTY_NOT_FOUND",
            "errorMessage": "string"
        }
    ]
}

🟠400

🟠401

🟠403

🟠429

🔴500