مرجع API

اشیاء

انواع ثبت شرکت شما (املاک، وسایل نقلیه، سفارشات...) و سوابق آنها.

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

get/api/v1/objects

مجوز کلیدی: leitura

پاسخ ها

200Tipos

درخواست کنید

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

مثال گویا

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

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

مجوز کلیدی: leitura

پارامترها

type string · caminhoاجباری

—

q string · consulta

—

پاسخ ها

200Registros
404Tipo não encontrado

درخواست کنید

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

مثال گویا

Criar registro (validado pelos campos do tipo)

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

مجوز کلیدی: escrita

پارامترها

type string · caminhoاجباری

—

بدنه (JSON)

data objectاجباری

مثال: {"endereco":"Rua A, 10","valor":450000,"situacao":"Disponível"}

پاسخ ها

201Criado
422Campos inválidos

درخواست کنید

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

مثال گویا

قبلیمذاکرات بعدیپرداخت ها