مواد پر جائیں۔

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

مثال گویا