Riferimento API

Oggetti

I tipi di registrazione della tua azienda (proprietà, veicoli, ordini...) e i relativi record.

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

get/api/v1/objects

Autorizzazione chiave: leitura

Risposte

200Tipos

Richiesta

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

Anschauliches Beispiel.

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

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

Autorizzazione chiave: leitura

Parametri

type string · caminhoobbligatorio

—

q string · consulta

—

Risposte

200Registros
404Tipo não encontrado

Richiesta

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

Anschauliches Beispiel.

Criar registro (validado pelos campos do tipo)

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

Autorizzazione chiave: escrita

Parametri

type string · caminhoobbligatorio

—

Corpo (JSON)

data objectobbligatorio

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

Risposte

201Criado
422Campos inválidos

Richiesta

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"}}'

Anschauliches Beispiel.

PrecedenteNegoziati ProssimoPagamenti