বিষয়বস্তু এড়িয়ে যান

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

مثال گویا