edywladson / vistasoft
用于消费 Vista Soft API 的库(Biblioteca para consumir a API da Vista Soft)
1.0.1
2021-03-01 11:52 UTC
Requires
- php: ^7.2
This package is auto-updated.
Last update: 2024-09-24 22:05:01 UTC
README
O VistaSoft API 是一个小型组件,可简化对 VistaSoft API 的消费。简单易用。
亮点
- 简单安装
- 易于使用并与 VistaSoft API 通信
- 为 composer 准备就绪且兼容 PSR-2
安装
通过 Composer 上传
"edywladson/vistasoft": "^1.0"
或使用终端
composer require edywladson/vistasoft
文档
有关如何使用的更多详细信息,请参阅组件目录中的 示例 文件夹。其中包含多个使用示例,请记住查阅 Vista Soft API 文档。
组件的工作方式如下
- fields() - [ARRAY] 在此处插入您希望在请求中接收的字段。
- leads() - [ARRAY] 用于发送 leads
- filter() - [ARRAY] 使用 filter 来筛选您需要的信息。
- order() - [ARRAY] order 用于对搜索结果进行排序。
- paginator() - 用于对内容进行分页。它可以接收 3 个参数,即 page(显示您当前所在的页面)、quantity(确定每页的结果数量)和 total(将返回请求项的总数)。默认情况下,已定义 page = 1,quantity = 20 和 total = false。
- clientId() - [INT] 用于提供客户 ID。
- immobileId() - [INT] 用于提供房地产 ID。
- get() - [STRING] 用于执行 GET 请求
- post() - [STRING] 用于执行 POST [客户、房地产和 leads 的注册]
- put() - [STRING] 用于执行 PUT [客户和房地产的更新]
- callback() - 返回请求的结果
客户查询、注册和更新
查询 [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();
注册 [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();
更新 [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();
房地产查询、注册和更新
查询 [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();
注册 [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();
更新 [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();
贡献
有关详细信息,请参阅 CONTRIBUTING。
支持
如果您发现与安全相关的任何问题,请通过 edywladson@gmail.com 发送电子邮件,而不是使用问题跟踪器。
谢谢
信用
- Edy Wladson(开发者)
- 所有贡献者(这座岩石)
许可证
MIT 许可证。请参阅 许可证文件 了解更多信息。