smartdealer/sdapi

Smart Dealer Client API

Smart Dealer Client API

Use a tecnologia Smart na sua empresa ou agência

98% de precisão na detecção automática de modelos/versões e compatibilidade de listas

API e documentação de comunicação (for PHP servers) com a plataforma para revendas e concessionárias Smart Dealer., _(*1)

, _(*2)

Para mais informações, acesse o nosso site., _(*3)

Direitos reservados à Smart Dealer Soluções em Software Ltda., _(*4)

Caso necessite de acesso a integração antiga, veja o SD Soap-XML., _(*5)

Requísitos

• PHP 5.3 ou superior
• Extensões do PHP "php_curl" e "php_openssl"
• Apache 2.2+

Use via composer

composer require smartdealer/sdapi

Autenticação

~~~.php, _(*6)

# include API class include_once 'src/smart/api.php';, _(*7)

# client name OR direct instance URL (prima or prima.smartdealer.com.br) $env = 'prima';, _(*8)

# login webservice Rest $usr = 'primafiat';, _(*9)

# password webservice Rest (example) $pwd = 'unXEmpkV7ush#';, _(*10)

# init API $api = new Smart\Api($env, $usr, $pwd, array());, _(*11)

### Acesso direto (url)

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

* {usuario}  = usuário do ws
* {chave}    = chave do ws
* {cliente}  = nome da instância
* {formato}   = formato do saída em JSON ou XML (vide parâmetros de configuração)
* {template} = estrutura de campos da saída 

### Uso em embiente de produção

Será necessário a criação de um login, chave de acesso e a liberação do endereço de IP (servidor onde a API será executada) pela Smart para autenticação no webservice Rest, ambiente de produção.

A solicitação poderá ser feita atravéz deste link: http://bit.ly/2bVryEC

![alt tag](http://smartdealership.com.br/img/api/sd-cad-usuario-integracao.jpg)

### Exemplo de uso

~~~.php
  # 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' 
    )
  )

Dicionário de dados

Tradução dos campos retornados na consulta das ofertas selecionadas do estoque., _(*12)

Tipos de métodos

GET (leitura de dados)

~~~.php, _(*13)

# reading data list $api->get('/route/method');, _(*14)

# reading specific data $api->get('/route/method/:id');, _(*15)

#### POST (envio de dados)

~~~.php

  $data = array();

  # send data (simple)
  $api->post('/route/method/', $data);

  # send data with ID param (if required)

  $api->post('/route/method/:id', $data);

DELETE (deleção de dados)

~~~.php, _(*16)

$data = array();, _(*17)

# remove data (required ID param) $api->delete('/route/method/:id');, _(*18)

##### Retorno padrão (para uso das rotas HTTP)

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

Tabela de tradução

Métodos do webservice (configuração)

GET : /config/categories/

Lista as categorias de veículos do estoque (carro, moto, caminhão), _(*19)

POST : /config/affiliate/

Cadastra um novo cliente/CNPJ no sistema, _(*20)

Filtros, _(*21)

Uso, _(*22)

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

GET : /config/affiliates/

Lista as filiais/lojas do cliente, _(*23)

Métodos do webservice (estoque de peças)

GET : /parts/

Lista o estoque de peças, _(*24)

GET : /parts/providers/

Lista os fabricantes cadastrados, _(*25)

POST : /parts/order/ [array]

Registra ou atualiza a reserva de uma peça (e-commerce), _(*26)

POST : /parts/notify/ [array]

Registra ou atualiza a lista de notificações, pendências no estoque (e-commerce), _(*27)

DELETE : /parts/order/:id

Remove a reserva de uma peça, _(*28)

Métodos do webservice (integrador)

GET : /connect/channels/

Lista os canais/portais disponíveis para integração, _(*29)

GET : /connect/codes/

Lista de tradução dos códigos de resposta dos canais de integração., _(*30)

Breve exemplo, para ver a lista completa faça uma chamada a rota Rest acima., _(*31)

POST : /connect/contract/

Cria uma configuração de integração (connect), _(*32)

Filtros, _(*33)

Uso, _(*34)

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

GET : /connect/contracts/

Lista as integrações configuradas (contratos de integração), _(*35)

POST : /connect/offer/

Cadastra um veículo para publicação em um pacote de ofertas (connect), _(*36)

Formato das imagens (em base64), _(*37)

, _(*38)

POST : /connect/offer/:id

Atualiza uma oferta de veículo no estoque (connect), _(*39)

A flag :id deverá ser substituída pelo código da oferta, ex: "/connect/offer/1"., _(*40)

Parâmetros da chamada, _(*41)

Formato das imagens (em base64), _(*42)

, _(*43)

Importante, _(*44)

O o tipo de estoque "U" para usados e "N" para novos não poderá ser alterado. Neste caso será necessário excluir a oferta e adicionar novamente no pacote (estoque)., _(*45)

GET : /connect/packs/

Lista os pacotes de ofertas disponíveis (connect), _(*46)

Filtros, _(*47)

Uso, _(*48)

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

GET : /connect/pack/:id

Lista as ofertas de um determinado pacote (connect), _(*49)

GET : /connect/offers/

Lista todas as ofertas do cliente, _(*50)

DELETE : /connect/offer/:id

Remove a oferta do pacote e do portal (pós sincronização automática), _(*51)

A flag :id deverá ser substituída pelo código da oferta, ex: "/connect/offer/1"., _(*52)

DELETE : /connect/contract/:id

Remove uma configuração de integração e seus pacotes (contrato), _(*53)

A flag :id deverá ser substituída pelo código do contrato, ex: "/connect/contract/1"., _(*54)

Parâmetros de configuração

~~~.php, _(*55)

# the API settings $settings = array( 'handle' => 'curl', 'timeout' => 10, 'use_ssl' => false, 'port' => 80, 'debug' => false, 'output_format' => 1, 'output_compile' => true );, _(*56)

# init API (with param settings) $api = new Smart\Api($env, $usr, $pwd, $settings);, _(*57)

~~~, _(*58)

handle

Escolha do método/protocolo de conexão com o servidor Restful., _(*59)

• String: "curl" (padrão), "socket" e "stream"

timeout

Tempo máximo da resposta do servidor em segundos., _(*60)

• Integer: 10 (padrão)

use_ssl

Habilitar esta opção se a conexão exigir SSL., _(*61)

• Bool: false (padrão)

port

Número da porta de conexão com servidor Restful., _(*62)

• Integer: 80 (padrão)

debug

Para desenvolvedores: se ativa, exibe erros de execução e comunicação com o servidor., _(*63)

• Bool: false (padrão)

output_format

Opção de configuração do formato de resposta do servidor ('JSON' = 1, 'XML' = 2)., _(*64)

• Integer: 1 (padrão)

output_compile

Se desativada, mostra a resposta literal do servidor em XML ou JSON., _(*65)

• Bool: true (padrão)

Integração com portais

Fluxo de interação com o webservice Smart via Api na integração com portais automotivos., _(*66)

, _(*67)

Atualização regular

@Release 1.6, _(*68)

Nota da versão:, _(*69)

Nenhuma., _(*70)