Vistoria Fácil API - Documentação

Acesse a documentação completa da API do Vistoria Fácil para integrar, automatizar e otimizar os processos de vistoria de obras e empreendimentos. Encontre todos os endpoints disponíveis, parâmetros necessários, e exemplos de chamadas para facilitar a integração com o seu sistema.

Acessar Documentação

Sobre o App Vistoria.Fácil

O Vistoria Fácil simplifica e automatiza vistorias, otimizando a entrega e o controle de qualidade de empreendimentos com agilidade e precisão, tudo em uma plataforma prática e personalizável.

Promo

Interface amigável

A Plataforma permite personalização de checklists e relatórios, oferecendo uma experiência adaptada às necessidades específicas de cada cliente.

Promo

Customização dos processos

O Vistoria Fácil permite uma completa customização dos processos de vistorias, organizando cada etapa conforme as necessidades do cliente.

Promo

Suporte

Nossa equipe está pronta para ajudar a resolver dúvidas e oferecer orientações práticas sobre o uso da plataforma, facilitando o atendimento e o suporte em tempo real para melhorar sua experiência.

Funcionalidades

O Vistoria Fácil reúne funcionalidades que otimizam, personalizam e centralizam processos de vistoria.

Design Responsivo

Adaptado para uso em celulares e tablets oferecendo uma experiência fluida em qualquer dispositivo.

Manager

Gerenciador WEB para configurar e personalizar suas vistorias.

API

Sistema disponibiliza API's de integração.

Suporte

Suporte por e-mail e Whatsapp.

Pesquisa de Satisfação

Realize pesquisa de satisfação off-line dentro do App.

Envio de notificações

Envio de mensagens por whatsapp e e-mail.

Como usar?

O que é API Swagger?

A API Swagger é uma ferramenta que permite descrever, documentar e testar APIs de forma visual e interativa. No caso do Vistoria Fácil, a API Swagger serve para fornecer uma interface clara e acessível para desenvolvedores, permitindo que eles entendam como interagir com os serviços oferecidos pela plataforma Vistoria Fácil.

Acessar a API Swagger

Dica: Siga os passos abaixo para utilização:

Primeiro você precisa obter o “guidToken” para conseguir utilizar demais métodos da API. Você precisa solicitar seu usuário e senha da API atraves do canal: Clique aqui para Solicitar acesso à API do Vistoria Fácil. Lembre-se de informar a sua chave de acesso ao APP e o responsável pelo seu contrato.

Documentação de Acesso à API Vistoria Fácil

Nossa API está liberada para acesso através do link: https://api.vistoriafacil.com.br/. O Swagger da API está no link: https://api.vistoriafacil.com.br/api/index.html.

Primeiro passo para Utilizar a API:

  1. Acessar o método /api/Acesso/GerarToken
    Você vai receber no retorno o “guidToken”, o qual será usado para utilizar demais métodos da API. Informe os parâmetros obrigatórios usuarioAPI e senhaAPI seu token “guidToken” será gerado.

    ATENÇÃO: Ele tem validade de uso, cuide a expiração e sempre renove seu token na rechamada deste mesmo método.

    Clique aqui para Solicitar acesso à API do Vistoria Fácil.

  2. Acessar o método /api/Agendamento/ListarUnidades/{CodigoIntegracaoEmpreendimento}
    Passando os parâmetros “guidToken” e “CodigoIntegracaoEmpreendimento”, você terá os status de todas as unidades importadas para o Vistoria Fácil.
    O “CodigoIntegracaoEmpreendimento” é o código do empreendimento de integração (SIENGE, MEGA, IMOBME, CRM Dynamics).

Métodos para a operação de Agendamento:

  1. ListarUnidades: Com este método você poderá consultar o status de todas as unidades e torres de um determinado empreendimento. Aqui você pode encontrar os parâmetros chaves como CodigoIntegracaoEmpreendimento, CodigoBloco, CodigoUnidade, parâmetros obrigatórios nos métodos seguintes.
  2. ConsultarHorarioDisponivel
    Informe os parâmetros: Código do Empreendimento, Torre, Unidade, QuantidadesDias (para gerar disponibilidades futuras).
    Os parâmetros “txtUser” e “txtKey” devem ser informados, correspondendo a um usuário cadastrado na plataforma para registrarmos as operações nos logs de auditoria do sistema. Esses campos são requisitados em outros métodos também.
  3. ConsultarDataAgendamento: Método utilizado para obter o status atual de uma unidade.
  4. ConfirmarAgendamento: Conforme os dados consultados no método ConsultarHorarioDisponivel, você terá os parâmetros necessários para confirmar um agendamento.
  5. CancelarAgendamento: Opção para cancelar um agendamento de vistoria.

Documentação da API Vistoria Fácil

Versão: v1

URL da API: https://api.vistoriafacil.com.br/api/index.html

Termos de Serviço: Link - Ver Termos de uso

Contato: https://afirma.cc/contato

Endpoints

1. /api/Acesso/GerarToken

POST - Gera um token de acesso para autenticar nas demais chamadas da API.

Parâmetros do Cabeçalho:

  • usuarioAPI (string): Seu usuário de acesso à API.
  • senhaAPI (string): Sua senha de acesso à API.

Respostas:

  • 200 OK: Retorna o token de acesso se as credenciais estiverem corretas.

2. /api/Agendamento/CancelarAgendamento

DELETE - Cancela o agendamento de uma unidade específica.

Parâmetros do Cabeçalho:

  • tokenAcesso (uuid): Token de autenticação.
  • txtUser (string): Usuário de controle de histórico de operação.
  • txtKey (string): Senha do usuário de operação.

Parâmetros do Formulário:

  • CodigoIntegracaoEmpreendimento (string): Código de integração do empreendimento.
  • CodigoBloco (string): Código do bloco.
  • CodigoUnidade (string): Código da unidade.

Respostas:

  • 200 OK: Agendamento cancelado com sucesso.
  • 400 Bad Request: Erro na requisição.
  • 401 Unauthorized: Token de acesso inválido.
  • 500 Internal Server Error: Erro interno.

3. /api/Agendamento/ConfirmarAgendamento

POST - Confirma o agendamento de uma unidade específica.

Parâmetros do Cabeçalho:

  • tokenAcesso (uuid): Token de autenticação.
  • txtUser (string): Usuário de controle de histórico de operação.
  • txtKey (string): Senha do usuário de operação.

Parâmetros do Formulário:

  • CodigoIntegracaoEmpreendimento (string): Código de integração do empreendimento.
  • CodigoBloco (string): Código do bloco.
  • CodigoUnidade (string): Código da unidade.
  • DataInicio (string): Data e hora de início do agendamento.
  • DataFinal (string): Data e hora de término do agendamento.
  • VistoriadorID (string): ID do vistoriador.

Respostas:

  • 200 OK: Agendamento confirmado com sucesso.
  • 400 Bad Request: Erro na requisição.
  • 401 Unauthorized: Token de acesso inválido.
  • 500 Internal Server Error: Erro interno.

4. /api/Agendamento/ConsultarDataAgendamento

GET - Consulta os dados do agendamento de uma unidade específica.

Parâmetros do Query:

  • CodigoIntegracaoEmpreendimento (string): Código de integração do empreendimento.
  • CodigoBloco (string): Código do bloco.
  • CodigoUnidade (string): Código da unidade.

Parâmetros do Cabeçalho:

  • tokenAcesso (uuid): Token de autenticação.
  • txtUser (string): Usuário de controle de histórico de operação.
  • txtKey (string): Senha do usuário de operação.

Respostas:

  • 200 OK: Dados do agendamento retornados.
  • 400 Bad Request: Erro na requisição.
  • 401 Unauthorized: Token de acesso inválido.
  • 500 Internal Server Error: Erro interno.

5. /api/Agendamento/ConsultarHorarioDisponivel

GET - Consulta a disponibilidade de agendamento de uma unidade.

Parâmetros do Query:

  • CodigoIntegracaoEmpreendimento (string): Código de integração do empreendimento.
  • CodigoBloco (string): Código do bloco.
  • CodigoUnidade (string): Código da unidade.
  • QuantidadesDias (integer): Número de dias para verificar a disponibilidade.

Parâmetros do Cabeçalho:

  • tokenAcesso (uuid): Token de autenticação.
  • txtUser (string): Usuário de controle de histórico de operação.
  • txtKey (string): Senha do usuário de operação.

Respostas:

  • 200 OK: Horários disponíveis retornados.
  • 400 Bad Request: Erro na requisição.
  • 401 Unauthorized: Token de acesso inválido.
  • 500 Internal Server Error: Erro interno.

Termos de Uso da API

Última atualização: 14 de novembro de 2024

1. Aceitação dos Termos

Ao acessar e utilizar este serviço, você concorda em cumprir e estar sujeito aos termos e condições descritos neste documento. Caso não concorde com algum desses termos, você não deverá utilizar o serviço.

2. Modificações nos Termos

Podemos alterar os termos e condições a qualquer momento. Quando isso ocorrer, a versão mais recente será publicada nesta página com a data de atualização indicada no topo do documento. Recomendamos que você consulte os termos periodicamente.

3. Descrição do Serviço

Este serviço fornece uma plataforma para [INTEGRAÇÃO VISTORIA.FÁCIL]. O objetivo é fornecer uma solução de alta qualidade para Serviços de Agendamentos e Sincronização de Dados Entre Sistemas.

4. Uso Permitido

Você concorda em usar o serviço apenas para fins legais e de acordo com as leis aplicáveis. É proibido usar o serviço de maneira que possa danificar, desabilitar, sobrecarregar ou prejudicar qualquer parte da plataforma.

5. Responsabilidades do Usuário

  • Fornecer informações verdadeiras e precisas durante o processo de cadastro.
  • Manter sua conta segura, incluindo a senha, e não compartilhar seus dados de login com terceiros.
  • Notificar imediatamente a equipe do serviço sobre qualquer uso não autorizado de sua conta.

6. Privacidade

Respeitamos sua privacidade e estamos comprometidos em proteger suas informações pessoais. Para saber mais sobre como coletamos, usamos e protegemos seus dados, consulte nossa Política de Privacidade.

7. Limitação de Responsabilidade

Não nos responsabilizamos por quaisquer danos diretos, indiretos, incidentais, especiais, punitivos ou consequenciais decorrentes do uso ou da incapacidade de usar o serviço.

8. Propriedade Intelectual

Todos os direitos de propriedade intelectual relacionados ao serviço, incluindo, mas não se limitando a, conteúdo, marcas registradas e patentes, são de nossa propriedade ou licenciados para nós.

9. Encerramento de Conta

Reservamo-nos o direito de suspender ou encerrar sua conta a qualquer momento, sem aviso prévio, caso identifiquemos violação dos termos de serviço ou uso indevido da plataforma.

10. Disposições Gerais

Se alguma cláusula deste termo for considerada inválida ou inaplicável, as demais disposições continuarão em pleno vigor e efeito. Este acordo é regido pelas leis do Brasil.

11. Contato

Se você tiver alguma dúvida sobre estes Termos de Serviço, entre em contato conosco através do e-mail: suporte@afirma.cc

Download Vistoria Fácil

O Vistoria Fácil está disponível para Android e iOS, oferecendo uma solução prática e eficiente para realizar vistorias diretamente do seu celular ou tablet. Com um design intuitivo e funcionalidade otimizada para dispositivos móveis, você pode gerenciar processos de vistorias de qualquer lugar, com facilidade e agilidade. Baixe agora e tenha o poder da gestão de vistorias na palma da sua mão!