API參考
物件
Os tipos de cadastro próprios da sua empresa (imóveis, veículos, pedidos…) e os seus registros.
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"}}'مثال گویا