PHPackages testtttttt/sdapi - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [API Development](/categories/api) 4. / 5. testtttttt/sdapi ActivePhp-library[API Development](/categories/api) testtttttt/sdapi ================ Smart Dealer Client API 00PHP Since Mar 23Pushed 4y agoCompare [ Source](https://github.com/ll3cram/sdapi)[ Packagist](https://packagist.org/packages/testtttttt/sdapi)[ RSS](/packages/testtttttt-sdapi/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (1)Used By (0) Smart Dealer Client API ======================= [](#smart-dealer-client-api) ### Use a tecnologia Smart na sua empresa ou agência [](#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 [](#98-de-precisão-na-detecção-automática-de-modelosversõ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. [![GPL Licence](https://camo.githubusercontent.com/37b8b4771f7595a6a62de0cdc9a864fd08183d548e2261e12508b23c475358cc/68747470733a2f2f6261646765732e66726170736f66742e636f6d2f6f732f67706c2f67706c2e7376673f763d313033)](https://opensource.org/licenses/MIT/) [![PHPPackages Rank](https://camo.githubusercontent.com/ed8b284fac0ffdbb955f870223ba8a2750aa6f6d133969d5ec662696a5c1c7d8/687474703a2f2f7068707061636b616765732e6f72672f702f736d6172746465616c65722f73646170692f62616467652f72616e6b2e737667)](http://phppackages.org/p/smartdealer/sdapi) [![](https://camo.githubusercontent.com/b303fccc635a06d813e5849530b408999ddc2d44beed5eec40ed98ab402a057d/68747470733a2f2f7265706f73732e6865726f6b756170702e636f6d2f3f706174683d736d6172746465616c65722f7364617069267374796c653d666c6174)](https://camo.githubusercontent.com/b303fccc635a06d813e5849530b408999ddc2d44beed5eec40ed98ab402a057d/68747470733a2f2f7265706f73732e6865726f6b756170702e636f6d2f3f706174683d736d6172746465616c65722f7364617069267374796c653d666c6174) Para mais informações, acesse o nosso [site](http://smartdealership.com.br). Direitos reservados à Smart Dealer Soluções em Software Ltda. Caso necessite de acesso a integração antiga, veja o [SD Soap-XML](https://github.com/smartdealer/sdpack). ### Requísitos [](#requísitos) - PHP 5.3 ou superior - Extensões do PHP "php\_curl" e "php\_openssl" - Apache 2.2+ ### Use via composer [](#use-via-composer) ``` composer require smartdealer/sdapi ``` ### Autenticação [](#autenticação) ``` # 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()); ``` ### Acesso direto (url) [](#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 [](#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: [![alt tag](https://camo.githubusercontent.com/45c171b7ae0b946a0e22086c5347e993270ed6cbdaa6e353f181a8d150994963/687474703a2f2f736d6172746465616c6572736869702e636f6d2e62722f696d672f6170692f73642d6361642d7573756172696f2d696e746567726163616f2e6a7067)](https://camo.githubusercontent.com/45c171b7ae0b946a0e22086c5347e993270ed6cbdaa6e353f181a8d150994963/687474703a2f2f736d6172746465616c6572736869702e636f6d2e62722f696d672f6170692f73642d6361642d7573756172696f2d696e746567726163616f2e6a7067) ### Exemplo de uso [](#exemplo-de-uso) ``` # 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 [](#dicionário-de-dados) Tradução dos campos retornados na consulta das ofertas selecionadas do estoque. campotipodescriçãoidinteger**id** da oferta nos pacotestipostringcódigo do tipo (N para novo e U para usado)categoriaintegercódigo da categoria (carro, moto ou caminhão)filialinteger**id** da filial, use a rota **/config/affiliates/** para listarplacastringplaca do veículo (para usados)chassistringchassi do veículo (para novos)marcastringdescrição da marcamodelo\_idstringcódigo do modelomodelostringdescrição do modelocor\_idstringcodigo da corcorstringdescrição da corkmintegerquilometragem do veículocombustivelstringdescrição do combustívelano\_fabricacaointeger (4)ano de facricação do veículoano\_modelointeger (4)ano do modelo do veículopromocaostringstatus do veículo em promoção (S ou N)precofloatpreço do veículodias\_estoqueintegernúmero dos dias em estoqueobservacaostringobservações do vendedor/concessionáriaimagensarraylista das URLs das imagens do veículo### Tipos de métodos [](#tipos-de-métodos) #### GET (leitura de dados) [](#get-leitura-de-dados) ``` # reading data list $api->get('/route/method'); # reading specific data $api->get('/route/method/:id'); ``` #### POST (envio de dados) [](#post-envio-de-dados) ``` $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) [](#delete-deleção-de-dados) ``` $data = array(); # remove data (required ID param) $api->delete('/route/method/:id'); ``` ##### Retorno padrão (para uso das rotas HTTP) [](#retorno-padrão-para-uso-das-rotas-http) ``` { "status": 500, "errors": [ "O limite de 1 conta(s) foi atingido. Entre em contato conosco." ], "response": false } ``` campotipodescriçãostatusintegercódigo de retornoerrorsarraylistagem de erros (se houver, status 500)responsemixedresposta adicional do método##### Tabela de tradução [](#tabela-de-tradução) códigodescrição200sucesso400em manutenção500error### Métodos do webservice (configuração) [](#métodos-do-webservice-configuração) ##### GET : /config/categories/ [](#get--configcategories) Lista as categorias de veículos do estoque (carro, moto, caminhão) campotipodescriçãoidintegerid da categoria\*descricaostringnome da categoria (Ex: Carro)##### POST : /config/affiliate/ [](#post--configaffiliate) Cadastra um novo cliente/CNPJ no sistema campotipodescriçãonomestringnome do cliente (Ex: Exemplo Fiat)cnpjintegercnpj do cliente (14 digitos)razao\_socialstringrazão social (Ex: Exemplo Fiat Veículos Ltda.)matrizbooleanespecifica se cadastro é matriz ou loja principal*Filtros* parâmetrotipodescriçãoexemplocnpjnumericCNPJ da filial80935893000104*Uso* ``` https://{usuario}:{chave}@{cliente}.smartdealer.com.br/webservice/rest/connect/contracts?param=value ``` ##### GET : /config/affiliates/ [](#get--configaffiliates) Lista as filiais/lojas do cliente campotipodescriçãonomestringnome do cliente (Ex: Exemplo Fiat)cepstringendereço de cepcnpjintegercnpj do cliente (14 digitos)razao\_socialstringrazão social (Ex: Exemplo Fiat Veículos Ltda.)enderecostringendereço da concessionária/revendabairrostringnome do bairrocidadestringnome da cidadetelefoneintegernúmero do telefone (dd + número)responsavelstringnome do contato responsávelemailstringemail do clientehashcodestringhash token criação de senha### Métodos do webservice (estoque de peças) [](#métodos-do-webservice-estoque-de-peças) ##### GET : /parts/ [](#get--parts) Lista o estoque de peças ##### GET : /parts/providers/ [](#get--partsproviders) Lista os fabricantes cadastrados ##### POST : /parts/order/ \[array\] [](#post--partsorder-array) Registra ou atualiza a reserva de uma peça (e-commerce) ##### POST : /parts/notify/ \[array\] [](#post--partsnotify-array) Registra ou atualiza a lista de notificações, pendências no estoque (e-commerce) ##### DELETE : /parts/order/:id [](#delete--partsorderid) Remove a reserva de uma peça ### Métodos do webservice (integrador) [](#métodos-do-webservice-integrador) ##### GET : /connect/channels/ [](#get--connectchannels) Lista os canais/portais disponíveis para integração campotipodescriçãoidintegercódigo do canalnomestringnome do canal (Ex: Portal iCarros)identificadorstringnome do drive identificador (Ex: icarros)statusinteger1 na fila, 2 em manutenção, 3 disponível##### GET : /connect/codes/ [](#get--connectcodes) Lista de tradução dos códigos de resposta dos canais de integração. Breve exemplo, para ver a lista completa faça uma chamada a rota Rest acima. codigodescricao7versão incompatível c/ o ano13a cor informada é inválida16plano ou categoria inválido21limite da categoria esgotado33preço abaixo do permitido (20% FIPE)300combustíveis não carregados##### POST : /connect/contract/ [](#post--connectcontract) Cria uma configuração de integração (connect) campotipodescriçãosite\_idintegerid do canal de integração (vide ~/channels/)statusinteger1 atualização automática ativa, 0 desativadaanunciosintegertotal de anúncios do plano (apenas para cálculo)nomestringnome de indentificação do contratofilialintegerfilial a ser lida/publicada (ofertas)cnpjintegercnpj utilizado na conta do portalloginstringlogin/email utilizado na conta do portalsenhastringsenha da conta do portalsegmentointegercategoria principal, vide "/config/categories/"*Filtros* parâmetrotipodescriçãoexemplofilialintegerID da filial1*Uso* ``` https://{usuario}:{chave}@{cliente}.smartdealer.com.br/webservice/rest/connect/contracts?param=value ``` ##### GET : /connect/contracts/ [](#get--connectcontracts) Lista as integrações configuradas (contratos de integração) campotipodescriçãoidintegercódigo do contrato/integraçãosite\_idintegerid do canal de integração vide "connect/channels/"data\_criacaostringdata do cadastro da integraçãoidentificadorstringnome do canal ou portal integrado (Ex: webmotors)nomestringnome de indentificação do contratostatusinteger1 atualização automática ativa, 0 desativadaanunciosintegertotal de anúncios do plano (definido no cadastro)tot\_destaqueintegertotal de anúncios em destaque (pós sincronização)tot\_manualintegeranúncios cadastrados pelo portal (pós sincronização)loginstringlogin/email utilizado na conta do portalsenhastringsenha da conta do portalsegmentointegercategoria principal, vide "/config/categories/"validobooleanstatus operacional da integração (true = integrado)##### POST : /connect/offer/ [](#post--connectoffer) Cadastra um veículo para publicação em um pacote de ofertas (connect) campotipodescriçãocontrato\_idintegercódigo da integração "/connect/contracts/"tipostringcódigo do tipo (N para novo e U para usado)categoriaintegercódigo da categoria "/config/categories/"placastringplaca do veículo (para usados)chassistringchassi do veículo (para novos)marcastringdescrição da marcamodelostringdescrição do modelocorstringdescrição da corportasintegerquantidade de portas do veículotransmissaostringdescrição da transmissãokmintegerquilometragem do veículocombustivelstringdescrição do combustívelano\_fabricacaointeger (4)ano de facricação do veículoano\_modelointeger (4)ano do modelo do veículopromocaostringstatus do veículo em promoção (S ou N)precofloatpreço do veículoobservacaostringobservações do vendedor/concessionáriaopcionaisstringopcionais separados por ";", ex: "ar condicionado;trava;direção"imagensarraylista\[0,1,2\] das imagens do veículo (código fonte em **BASE64**)*Formato das imagens (em base64)* [![alt tag](https://camo.githubusercontent.com/9bc03eb633d0444e674633d0c47d3f9ea657c2cd02e8a90ee8289e2d1c719691/687474703a2f2f736d6172746465616c6572736869702e636f6d2e62722f696d672f6170692f666f726d61746f2d6261736536342d696d6167656e732e706e67)](https://camo.githubusercontent.com/9bc03eb633d0444e674633d0c47d3f9ea657c2cd02e8a90ee8289e2d1c719691/687474703a2f2f736d6172746465616c6572736869702e636f6d2e62722f696d672f6170692f666f726d61746f2d6261736536342d696d6167656e732e706e67) ##### POST : /connect/offer/:id [](#post--connectofferid) Atualiza uma oferta de veículo no estoque (connect) campotipodescriçãoidinteger**id** da oferta em estoqueA flag :id deverá ser substituída pelo código da oferta, ex: "/connect/offer/1". *Parâmetros da chamada* campotipodescriçãocategoriaintegercódigo da categoria "/config/categories/"placastringplaca do veículo (para usados)chassistringchassi do veículo (para novos)marcastringdescrição da marcamodelostringdescrição do modelocorstringdescrição da corportasintegerquantidade de portas do veículotransmissaostringdescrição da transmissãokmintegerquilometragem do veículocombustivelstringdescrição do combustívelano\_fabricacaointeger (4)ano de facricação do veículoano\_modelointeger (4)ano do modelo do veículopromocaostringstatus do veículo em promoção (S ou N)precofloatpreço do veículoobservacaostringobservações do vendedor/concessionáriaopcionaisstringopcionais separados por ";", ex: "ar condicionado;trava;direção"imagensarraylista\[0,1,2\] das imagens do veículo (código fonte em **BASE64**)*Formato das imagens (em base64)* [![alt tag](https://camo.githubusercontent.com/9bc03eb633d0444e674633d0c47d3f9ea657c2cd02e8a90ee8289e2d1c719691/687474703a2f2f736d6172746465616c6572736869702e636f6d2e62722f696d672f6170692f666f726d61746f2d6261736536342d696d6167656e732e706e67)](https://camo.githubusercontent.com/9bc03eb633d0444e674633d0c47d3f9ea657c2cd02e8a90ee8289e2d1c719691/687474703a2f2f736d6172746465616c6572736869702e636f6d2e62722f696d672f6170692f666f726d61746f2d6261736536342d696d6167656e732e706e67) *Importante* 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). ##### GET : /connect/packs/ [](#get--connectpacks) Lista os pacotes de ofertas disponíveis (connect) campotipodescriçãoidintegercódigo do pacotenomestringnome customizado do pacote (Ex: Feirão iCarros)statusinteger1 ativo, 0 bloqueadoultimo\_enviodatetimedata do ultimo envio*Filtros* parâmetrotipodescriçãoexemplocontratonumericID da integração1*Uso* ``` https://{usuario}:{chave}@{cliente}.smartdealer.com.br/webservice/rest/connect/contracts?param=value ``` ##### GET : /connect/pack/:id [](#get--connectpackid) Lista as ofertas de um determinado pacote (connect) campotipodescriçãoidinteger**id** da ofertaordemintegerposição no pacote (ordem de publicação)pacote\_idintegercódigo do pacote de ofertasdriverstringidentificador do canal de integração, ex: "icarros"tipostringcódigo do tipo (N para novo e U para usado)categoriaintegercódigo da categoria (carro, moto ou caminhão)filialinteger**id** da filial, use a rota **/config/affiliates/** para listarplacastringplaca do veículo (para usados)chassistringchassi do veículo (para novos)marcastringdescrição da marcamodelo\_idstringcódigo do modelomodelostringdescrição do modelocor\_idstringcodigo da corcorstringdescrição da corkmintegerquilometragem do veículocombustivelstringdescrição do combustívelano\_fabricacaointeger (4)ano de facricação do veículoano\_modelointeger (4)ano do modelo do veículopromocaostringstatus do veículo em promoção (S ou N)precofloatpreço do veículodias\_estoqueintegernúmero dos dias em estoqueopcionaisstringopcionais separados por ";", ex: "ar condicionado;trava;direção"observacaostringobservações do vendedor/concessionáriaimagensarraylista das URLs das imagens do veículoregistrodatetimedata da ultima atualização no portalordemintegernúmero da sequência no pacoteanuncio\_statusstringstatus de publicação no portal 1 = publicado, 0 = offlineanuncio\_enviostringdata da ultima sincronização do anúncioanuncio\_codigostringcódigo do anúncio no portalanuncio\_linkstringlink do anúncio no portalstatus\_codigostringcódigo de retornostatus\_descricaostringtradução do retorno##### GET : /connect/offers/ [](#get--connectoffers) Lista todas as ofertas do cliente campotipodescriçãoidinteger**id** da ofertaordemintegerposição no pacote (ordem de publicação)pacote\_idintegercódigo do pacote de ofertasdriverstringidentificador do canal de integração, ex: "icarros"tipostringcódigo do tipo (N para novo e U para usado)categoriaintegercódigo da categoria (carro, moto ou caminhão)filialinteger**id** da filial, use a rota **/config/affiliates/** para listarplacastringplaca do veículo (para usados)chassistringchassi do veículo (para novos)marcastringdescrição da marcamodelo\_idstringcódigo do modelomodelostringdescrição do modelocor\_idstringcodigo da corcorstringdescrição da corkmintegerquilometragem do veículocombustivelstringdescrição do combustívelano\_fabricacaointeger (4)ano de facricação do veículoano\_modelointeger (4)ano do modelo do veículopromocaostringstatus do veículo em promoção (S ou N)precofloatpreço do veículodias\_estoqueintegernúmero dos dias em estoqueopcionaisstringopcionais separados por ";", ex: "ar condicionado;trava;direção"observacaostringobservações do vendedor/concessionáriaimagensarraylista das URLs das imagens do veículoregistrodatetimedata da ultima atualização no portalordemintegernúmero da sequência no pacoteanuncio\_statusstringstatus de publicação no portal 1 = publicado, 0 = offlineanuncio\_enviostringdata da ultima sincronização do anúncioanuncio\_codigostringcódigo do anúncio no portalanuncio\_linkstringlink do anúncio no portalstatus\_codigostringcódigo de retornostatus\_descricaostringtradução do retorno##### DELETE : /connect/offer/:id [](#delete--connectofferid) Remove a oferta do pacote e do portal (pós sincronização automática) campotipodescriçãoidinteger**id** da oferta no pacoteA flag :id deverá ser substituída pelo código da oferta, ex: "/connect/offer/1". ##### DELETE : /connect/contract/:id [](#delete--connectcontractid) Remove uma configuração de integração e seus pacotes (contrato) campotipodescriçãoidinteger**id** do contratoA flag :id deverá ser substituída pelo código do contrato, ex: "/connect/contract/1". ### Parâmetros de configuração [](#parâmetros-de-configuração) ``` # 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 [](#handle) Escolha do método/protocolo de conexão com o servidor Restful. - String: "curl" (padrão), "socket" e "stream" #### timeout [](#timeout) Tempo máximo da resposta do servidor em segundos. - Integer: 10 (padrão) #### use\_ssl [](#use_ssl) Habilitar esta opção se a conexão exigir SSL. - Bool: false (padrão) #### port [](#port) Número da porta de conexão com servidor Restful. - Integer: 80 (padrão) #### debug [](#debug) Para desenvolvedores: se ativa, exibe erros de execução e comunicação com o servidor. - Bool: false (padrão) #### output\_format [](#output_format) Opção de configuração do formato de resposta do servidor ('JSON' = 1, 'XML' = 2). - Integer: 1 (padrão) #### output\_compile [](#output_compile) Se desativada, mostra a resposta literal do servidor em XML ou JSON. - Bool: true (padrão) ### Integração com portais [](#integração-com-portais) Fluxo de interação com o webservice Smart via Api na integração com portais automotivos. [![alt tag](https://camo.githubusercontent.com/00f45ad591f7af054f4129bd06610ad197355732a098a88b2c97427f17c8923c/687474703a2f2f736d6172746465616c6572736869702e636f6d2e62722f696d672f6170692f666c75786f6772616d612d696e746567726163616f2d7669612d6170692e706e67)](https://camo.githubusercontent.com/00f45ad591f7af054f4129bd06610ad197355732a098a88b2c97427f17c8923c/687474703a2f2f736d6172746465616c6572736869702e636f6d2e62722f696d672f6170692f666c75786f6772616d612d696e746567726163616f2d7669612d6170692e706e67) ### Atualização regular [](#atualização-regular) @Release 1.6 Nota da versão: Nenhuma. ### Health Score 14 — LowBetter than 2% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity0 Limited adoption so far Community9 Small or concentrated contributor base Maturity26 Early-stage or recently created project Bus Factor1 Top contributor holds 97.6% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/5e04c345320f73969e10cbd3266c469d34858bf4a01e6cd6903ca194d050a5bf?d=identicon)[r00t](/maintainers/r00t) --- Top Contributors [![phpenterprise](https://avatars.githubusercontent.com/u/1564781?v=4)](https://github.com/phpenterprise "phpenterprise (124 commits)")[![llecram](https://avatars.githubusercontent.com/u/1171451?v=4)](https://github.com/llecram "llecram (2 commits)")[![jeancsantos](https://avatars.githubusercontent.com/u/14297707?v=4)](https://github.com/jeancsantos "jeancsantos (1 commits)") ### Embed Badge ![Health badge](/badges/testtttttt-sdapi/health.svg) ``` [![Health](https://phpackages.com/badges/testtttttt-sdapi/health.svg)](https://phpackages.com/packages/testtttttt-sdapi) ``` ### Alternatives [stripe/stripe-php Stripe PHP Library 4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk A PHP wrapper for Twilio's API 1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api GitHub API v3 client 2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk PHP SDK for Facebook Business 90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php PHP wrapper for the Meilisearch API 73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax Google API Core for PHP 263103.1M454](/packages/google-gax) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)