הפניה ל-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"}}'

مثال گویا

קוֹדֵםמשא ומתן הַבָּאתשלומים