सामग्री पर जाएं

एपीआई संदर्भ

वस्तुओं

आपकी कंपनी के स्वयं के पंजीकरण प्रकार (संपत्तियाँ, वाहन, ऑर्डर...) और उनके रिकॉर्ड।

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

مثال گویا