Imobzi icon

Imobzi

Interagir com a API da Imobzi
Join our community

Actions62

Overview

This node integrates with the Imobzi API to perform various operations on different resources, including contracts ("Contrato"). Specifically, the "Get" operation for the "Contrato" resource retrieves detailed information about a single contract by its name or ID. This is useful when you need to fetch specific contract data for further processing, reporting, or automation workflows.

Practical examples:

  • Retrieve contract details to verify terms before proceeding with a rental agreement.
  • Fetch contract information to update related records in other systems.
  • Use contract data as part of a notification or approval workflow.

Properties

Name Meaning
Contract Name or ID Select a contract from a dropdown list loaded dynamically from the Imobzi API, or specify an ID manually.

Output

The node outputs a JSON object containing the contract data retrieved from the Imobzi API. The structure corresponds directly to the contract resource's fields as defined by Imobzi. The output is accessible under the json property of the node's output item.

No binary data is produced by this operation.

Example output snippet (conceptual):

{
  "id": 123,
  "client": "John Doe",
  "startDate": "2023-01-01",
  "endDate": "2023-12-31",
  "value": 1500,
  ...
}

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Imobzi API.
  • The node uses the Imobzi API endpoints corresponding to the selected resource and operation.
  • Network connectivity to the Imobzi API service is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Specifying an invalid or non-existent contract ID will result in errors or empty responses.
    • Network issues may cause request timeouts or failures.

  • Error messages:

    • "Recurso \"contrato\" não suportado!" indicates the resource is not recognized; ensure the resource name is correct.
    • "Operação \"get\" não suportada!" means the operation is unsupported; verify the operation parameter.
    • API errors returned from Imobzi (e.g., 404 Not Found) typically mean the contract ID does not exist.

  • Resolutions:

    • Verify and configure valid API credentials.
    • Confirm the contract ID exists in Imobzi before running the node.
    • Check network connectivity and API endpoint availability.
    • Enable "Continue On Fail" in the node settings to handle errors gracefully during batch executions.

Links and References

Discussion