README

在您的企业或机构中使用Smart技术

自动检测模型/版本和兼容性列表的准确率达到98%

与Smart经销商平台进行通信的API和文档（适用于PHP服务器）

更多信息，请访问我们的网站。

版权所有 Smart Dealer Soluções em Software Ltda.

如需访问旧版集成，请查看SD Soap-XML。

要求

• PHP 5.3或更高版本
• PHP "php_curl"和"php_openssl"扩展
• Apache 2.2+

通过composer使用

composer require smartdealer/sdapi

认证

  # include API class
  include_once 'src/smart/api.php';
  
  # client name OR direct instance URL (prima or prima.smartdealer.com.br)
  $env = 'prima';
  
  # login webservice Rest
  $usr = 'primafiat';    
  
  # password webservice Rest (example)
  $pwd = 'unXEmpkV7ush#';     
  
  # init API
  $api = new Smart\Api($env, $usr, $pwd, array());
  

直接访问（URL）

https://{usuario}:{chave}@{cliente}.smartdealer.com.br/webservice/rest/connect/offers/?format={formato}&template={template}

• {usuario} = ws用户
• {chave} = ws密钥
• {cliente} = 实例名称
• {formato} = 输出格式为JSON或XML（请参阅配置参数）
• {template} = 输出字段的架构

生产环境使用

需要创建登录、访问密钥并经Smart批准IP地址（运行API的服务器）以在Rest Web服务生产环境中进行认证。

可通过以下链接进行请求：http://bit.ly/2bVryEC

使用示例

  # call method
  $ret = $api->get('/parts/');
  
  # output (Array)
  array(
    0 => array(
      'codigo' => 0001
      'nome'   => 'Parachoque Dianteiro (Palio ELX)',
      'modelo' => 'MCBSA-12',
      'preco'  => 840.00,
      'qtd'    => 10,
      'fab'    => '1 - FIAT' 
    ),
    1 => array(
      'codigo' => 0002
      'nome'   => 'Parachoque Traseiro (Palio ELX/EX)',
      'modelo' => 'MCBSA-15',
      'preco'  => 532.00,
      'qtd'    => 7
      'fab'    => '1 - FIAT' 
    ),
    2 => array(
      'codigo' => 0003
      'nome'   => 'Motor Limpador de Parabrisa (UNO Vivace)',
      'modelo' => 'MCBSA-88',
      'preco'  => 120.00,
      'qtd'    => 2,
      'fab'    => '1 - FIAT' 
    )
  )
  

数据字典

翻译查询所选库存优惠的返回字段。

方法类型

GET（读取数据）

  
  # reading data list
  $api->get('/route/method');
  
  # reading specific data
  $api->get('/route/method/:id');

POST（发送数据）

  
  $data = array();
  
  # send data (simple)
  $api->post('/route/method/', $data);
  
  # send data with ID param (if required)
  
  $api->post('/route/method/:id', $data);
  

DELETE（删除数据）

  
  $data = array();
  
  # remove data (required ID param) 
  $api->delete('/route/method/:id');
  

默认返回值（用于HTTP路由）

{
  "status": 500,
  "errors": [
    "O limite de 1 conta(s) foi atingido. Entre em contato conosco."
  ],
  "response": false
}

翻译表

Web服务方法（配置）

GET : /config/categories/

列出库存车辆类别（汽车、摩托车、卡车）

POST : /config/affiliate/

在系统中登记新的客户/CNPJ

过滤器

用途

https://{usuario}:{chave}@{cliente}.smartdealer.com.br/webservice/rest/connect/contracts?param=value

GET : /config/affiliates/

列出客户的分支/商店

Web服务方法（零件库存）

GET : /parts/

列出零件库存

GET : /parts/providers/

列出已登记的制造商

POST : /parts/order/ [array]

注册或更新零件的预留（电子商务）

POST : /parts/notify/ [array]

注册或更新库存通知、待办事项（电子商务）

DELETE : /parts/order/:id

删除零件预留

Web服务方法（集成器）

GET : /connect/channels/

列出可用于集成的通道/门户

GET : /connect/codes/

集成通道响应代码的翻译列表。

简例，要查看完整列表，请调用上述Rest路由。

POST : /connect/contract/

创建集成配置（connect）

过滤器

用途

https://{usuario}:{chave}@{cliente}.smartdealer.com.br/webservice/rest/connect/contracts?param=value

GET : /connect/contracts/

列出配置的集成（集成合同）

POST : /connect/offer/

注册车辆以在包中发布（connect）

图像格式（base64）

POST : /connect/offer/:id

更新库存中的车辆优惠（connect）

id标志将替换为优惠代码，例如："/connect/offer/1"。

调用参数

图像格式（base64）

重要

库存类型"U"用于二手和"N"用于新货不得更改。在这种情况下，需要删除优惠并重新添加到包中（库存）。

GET : /connect/packs/

列出可用的优惠包（connect）

过滤器

用途

https://{usuario}:{chave}@{cliente}.smartdealer.com.br/webservice/rest/connect/contracts?param=value

GET : /connect/pack/:id

列出特定包中的优惠（connect）

GET : /connect/offers/

列出所有客户报价

DELETE : /connect/offer/:id

从套餐和门户中删除报价（自动同步后）

id标志将替换为优惠代码，例如："/connect/offer/1"。

DELETE : /connect/contract/:id

删除集成配置及其套餐（合同）

:id 标志应替换为合同代码，例如："/connect/contract/1"。

配置参数

  # the API settings
  $settings = array(
    'handle' => 'curl',
    'timeout' => 10,
    'use_ssl' => false,
    'port' => 80,
    'debug' => false,
    'output_format' => 1,
    'output_compile' => true
  );
  
  # init API (with param settings)
  $api = new Smart\Api($env, $usr, $pwd, $settings);
  
 

handle

选择与 Restful 服务器连接的方法/协议。

• String: "curl"（默认），"socket" 和 "stream"

timeout

服务器响应的最大时间（秒）。

• Integer: 10（默认）

use_ssl

如果连接需要 SSL，则启用此选项。

• Bool: false（默认）

port

与 Restful 服务器连接的端口号。

• Integer: 80（默认）

debug

针对开发者：如果启用，将显示执行和与服务器通信的错误。

• Bool: false（默认）

output_format

配置服务器响应格式的选项（'JSON' = 1，'XML' = 2）。

• Integer: 1（默认）

output_compile

如果禁用，将显示服务器在 XML 或 JSON 中的原始响应。

• Bool: true（默认）

门户集成

与汽车门户集成中通过 API 与 webservice Smart 的交互流程。

定期更新

@Release 1.6

版本说明

无。