Référence API

Objets

Les types d'enregistrement de votre entreprise (propriétés, véhicules, commandes...) et leurs enregistrements.

Listar os tipos de objeto do negócio (imóveis, veículos…) e seus campos

get/api/v1/objects

Autorisation de clé : leitura

Réponses

200Tipos

Demande

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

Autorisation de clé : leitura

Paramètres

type string · caminhoobligatoire

—

q string · consulta

—

Réponses

200Registros
404Tipo não encontrado

Demande

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

Autorisation de clé : escrita

Paramètres

type string · caminhoobligatoire

—

Corps (JSON)

data objectobligatoire

Exemple : {"endereco":"Rua A, 10","valor":450000,"situacao":"Disponível"}

Réponses

201Criado
422Campos inválidos

Demande

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.

PrécédentNégociations SuivantPaiements