edywladson/vistasoft

Library to consume the Vista Soft API (Biblioteca para consumir a API da Vista Soft)

1.0.1 2021-03-01 11:52 UTC

Requires

• php: ^7.2

MIT

• Edy Wladson

• api
• vista
• vistasoft
• Edy Wladson
• Vista Soft
• Vista Soft API

README

O VistaSoft API é um pequeno componente que facilita o consumo da API da VistaSoft. Simples e fácil de usar.

Destaques

• Instalação simples
• Fácil de utilizar e de comunicar com a API da VistaSoft
• Pronto para o composer e compatível com PSR-2

Instalação

Uploader através do Composer:

"edywladson/vistasoft": "^1.0"

ou utilize o terminal

composer require edywladson/vistasoft

Documentação

Para mais detalhes sobre como usar, veja uma pasta de exemplo no diretório do componente. Nela terá vários exemplos de uso, lembre também de consultar a documentação da API da Vista Soft.

O componente funciona assim:

• fields() - [ARRAY] Insira aqui os campos que você deseja receber no seu request.
• leads() - [ARRAY] Utilizado para o envio de leads
• filter() - [ARRAY] Utilize o filter para filtrar as informações que você precisa.
• order() - [ARRAY] O order é utilizado para ordenar a sua pesquisa.
• paginator() - Utilize para realizar paginação do conteúdo. Ele pode receber 3 parâmetros, o page que mostra em qual página você está, o quantity que determina quantos resultados por página e o total que retornará quantidade total de itens da solicitação. Por padrão já é definido o page = 1, quantity = 20 e total = false.
• clientId() - [INT] Utilize para informar o ID do cliente.
• immobileId() - [INT] Utilize para informar o ID do imóvel.
• get() - [STRING] Utilizado para realizar uma soliciação GET
• post() - [STRING] Utilizado para realizar um POST [Cadastro de clientes, imóveis e leads]
• put() - [STRING] Utilizado para realizar um PUT [Atualização de clientes e imóveis]
• callback() - Retorna o resultado da solicitação

Consulta, cadastro e atualiação de clientes

Consulta [GET]:

require __DIR__ . "/../vendor/autoload.php";

$vista = new \EdyWladson\VistaSoft\VistaSoft("api_url", "api_key");

$get = $vista
    ->fields([["Codigo", "Nome"])
    ->filter(["DataAtualizacao" => ["2021-01-10", "2021-02-10"]])
    ->order(["Codigo" => "asc"])
    ->paginator(1, 10, true)
    ->get("/clientes/listar")->callback();

Cadastro [POST]:

require __DIR__ . "/../vendor/autoload.php";

$vista = new \EdyWladson\VistaSoft\VistaSoft("api_url", "api_key");

$post = $vista
    ->fields(["Nome" => "João Felix", "FonePrincipal" => "00 0000 0000", "VeiculoCaptacao" => "Portal 10"])
    ->post("/clientes/detalhes")->callback();

Atualização [PUT]:

require __DIR__ . "/../vendor/autoload.php";

$vista = new \EdyWladson\VistaSoft\VistaSoft("api_url", "api_key");

$put = $vista
    ->clientId(73)
    ->fields(["FoneResidencial" => "21 8653 9050"])
    ->put("/clientes/detalhes")->callback();

Consulta, cadastro e atualiação de imóveis

Consulta [GET]:

require __DIR__ . "/../vendor/autoload.php";

$vista = new \EdyWladson\VistaSoft\VistaSoft("api_url", "api_key");

$get = $vista
    ->fields(["Codigo", "Bairro"])
    ->filter(["Bairro" => ["Centro", "Moema"]])
    ->order(["Bairro" => "asc"])
    ->paginator()
    ->get("/imoveis/listar")->callback();

Cadastro [POST]:

require __DIR__ . "/../vendor/autoload.php";

$vista = new \EdyWladson\VistaSoft\VistaSoft("api_url", "api_key");

$post = $vista
    ->fields(["Categoria"=>"Apartamento","Endereco"=>"Rua Victor Meirelles","NumeroEnd"=>"600","Complemento"=>"901","Bairro"=>"Campinas","Cidade"=>"São José","UF"=>"SC","CEP"=>"88101170","Situacao"=>"Novo","Ocupacao"=>"Ocupado"])
    ->post("/imoveis/detalhes")->callback();

Atualização [PUT]:

require __DIR__ . "/../vendor/autoload.php";

$vista = new \EdyWladson\VistaSoft\VistaSoft("api_url", "api_key");

$put = $vista
    ->immobileId(3152)
    ->fields(["NumeroEnd"=>"700"])
    ->put("/imoveis/listar")->callback();

Contribuindo

Consulte o CONTRIBUTING para obter detalhes.

Suporte

Se você descobrir algum problema relacionado à segurança, envie um e-mail para [e-mail] em vez de usar o rastreador de problemas.

Obrigado

Créditos

• Edy Wladson (Developer)
• All Contributors (This Rock)

Licença

A Licença MIT. Por favor, veja o Arquivo da Licença para maiores informações.