İçeriğe atla

API referansı

Nesneler

Firmanızın kendi tescil türleri (gayrimenkuller, araçlar, siparişler...) ve kayıtları.

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

get/api/v1/objects

Anahtar İzni: leitura

Cevaplar

  • 200Tipos
Rica etmek
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

Anahtar İzni: leitura

Parametreler

type string · caminhozorunlu

—

q string · consulta

—

Cevaplar

  • 200Registros
  • 404Tipo não encontrado
Rica etmek
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

Anahtar İzni: escrita

Parametreler

type string · caminhozorunlu

—

Gövde (JSON)

data objectzorunlu

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

Cevaplar

  • 201Criado
  • 422Campos inválidos
Rica etmek
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.