Referência da API

Objetos

Os tipos de cadastro próprios da sua empresa (imóveis, veículos, pedidos…) e os seus registros.

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

get/api/v1/objects

Permissão da chave: leitura

Respostas

200Tipos

Requisição

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

Permissão da chave: leitura

Parâmetros

type string · caminhoobrigatório

—

q string · consulta

—

Respostas

200Registros
404Tipo não encontrado

Requisição

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

Permissão da chave: escrita

Parâmetros

type string · caminhoobrigatório

—

Corpo (JSON)

data objectobrigatório

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

Respostas

201Criado
422Campos inválidos

Requisição

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.

AnteriorNegociações PróximoPagamentos