Referencia API

Objetos

Los tipos de registro propios de su empresa (propiedades, vehículos, pedidos...) y sus registros.

Listar os tipos de objeto do negócio (imóveis, veículos…) e seus campos

get/api/v1/objects

Permiso clave: leitura

Respuestas

200Tipos

Pedido

curl "https://www.cyzyra.com/api/v1/objects" \
  -H "Authorization: Bearer $CYZYRA_API_KEY"

Przykład ilustrujący.

Listar registros de um tipo de objeto (id ou chave, ex.: imovel)

get/api/v1/objects/{type}/records

Permiso clave: leitura

Parámetros

type string · caminhoobligatorio

—

q string · consulta

—

Respuestas

200Registros
404Tipo não encontrado

Pedido

curl "https://www.cyzyra.com/api/v1/objects/imovel/records" \
  -H "Authorization: Bearer $CYZYRA_API_KEY"

Przykład ilustrujący.

Criar registro (validado pelos campos do tipo)

post/api/v1/objects/{type}/records

Permiso clave: escrita

Parámetros

type string · caminhoobligatorio

—

Cuerpo (JSON)

data objectobligatorio

Ejemplo: {"endereco":"Rua A, 10","valor":450000,"situacao":"Disponível"}

Respuestas

201Criado
422Campos inválidos

Pedido

curl -X POST "https://www.cyzyra.com/api/v1/objects/imovel/records" \
  -H "Authorization: Bearer $CYZYRA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"data":{"endereco":"Rua A, 10","valor":450000,"situacao":"Disponível"}}'

Przykład ilustrujący.

AnteriorNegociaciones PróximoPagos