Odniesienie do API

Obiekty

Własne typy rejestracji Twojej firmy (nieruchomości, pojazdy, zamówienia...) i ich zapisy.

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

get/api/v1/objects

Kluczowe pozwolenie: leitura

Odpowiedzi

200Tipos

Wniosek

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

Kluczowe pozwolenie: leitura

Parametry

type string · caminhoobowiązkowy

—

q string · consulta

—

Odpowiedzi

200Registros
404Tipo não encontrado

Wniosek

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

Kluczowe pozwolenie: escrita

Parametry

type string · caminhoobowiązkowy

—

Treść (JSON)

data objectobowiązkowy

Przykład: {"endereco":"Rua A, 10","valor":450000,"situacao":"Disponível"}

Odpowiedzi

201Criado
422Campos inválidos

Wniosek

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.

PoprzedniUkłady NastępnyPłatności