مرجع واجهة برمجة التطبيقات

أشياء

أنواع التسجيلات الخاصة بشركتك (عقارات، مركبات، أوامر...) وسجلاتها.

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

مثال گویا

سابقالمفاوضات التاليالمدفوعات