Справочник по 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"

Przykład ilustrujący.

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"

Przykład ilustrujący.

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

Przykład ilustrujący.

ПредыдущийПереговоры СледующийПлатежи