API-Referenz

Objekte

Die eigenen Registrierungsarten Ihres Unternehmens (Liegenschaften, Fahrzeuge, Aufträge...) und deren Aufzeichnungen.

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

get/api/v1/objects

Schlüsselberechtigung: leitura

Antworten

200Tipos

Anfrage

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

Schlüsselberechtigung: leitura

Parameter

type string · caminhoobligatorisch

—

q string · consulta

—

Antworten

200Registros
404Tipo não encontrado

Anfrage

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

Schlüsselberechtigung: escrita

Parameter

type string · caminhoobligatorisch

—

Körper (JSON)

data objectobligatorisch

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

Antworten

201Criado
422Campos inválidos

Anfrage

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.

VorherigeVerhandlungen NächsteZahlungen