Download the PHP package gpupo/cnova-sdk without Composer

Cnova-SDK

SDK Não Oficial para integração a partir de aplicações PHP com as APIs da Cnova Marketplace (Extra.com.br, Pontofrio.com.br, Casasbahia.com.br)

Requisitos para uso

• PHP >= 5.6
• curl extension
• Composer Dependency Manager

Este componente não é uma aplicação Stand Alone e seu objetivo é ser utilizado como biblioteca. Sua implantação deve ser feita por desenvolvedores experientes.

Isto não é um Plugin!

As opções que funcionam no modo de comando apenas servem para depuração em modo de desenvolvimento.

A documentação mais importante está nos testes unitários. Se você não consegue ler os testes unitários, eu recomendo que não utilize esta biblioteca.

Direitos autorais e de licença

Este componente está sob a licença MIT

Para a informação dos direitos autorais e de licença você deve ler o arquivo de licença que é distribuído com este código-fonte.

Resumo da licença

Exigido:

• Aviso de licença e direitos autorais

Permitido:

• Uso comercial
• Modificação
• Distribuição
• Sublicenciamento

Proibido:

• Responsabilidade Assegurada

Indicadores de qualidade

Agradecimentos

• A todos os que contribuiram com patchs;
• Aos que fizeram sugestões importantes;

• Aos desenvolvedores que criaram as bibliotecas utilizadas neste componente.

  - Gilmar Pupo

Instalação

Adicione o pacote cnova-sdk ao seu projeto utilizando composer:

composer require gpupo/cnova-sdk

Uso

Este exemplo demonstra o uso simplificado a partir do Factory:

Acesso a lista de produtos cadastrados:

$produtosCadastrados = $manager->fetch(); // Collection de Objetos Product

Acesso a informações de um produto cadastrado e com identificador conhecido:

$produto = $manager->findById(9)); // Objeto Produto
echo $product->getTitle(); // Acesso ao nome do produto de Id 9

Criação de um produto:

$data = []; // Veja o formato de $data em Resources/fixture/Product/ProductId.json
$product = $cnovaSdk->createProduct($data);

Envio do produto para o Marketplace:

$manager->save($product);

Registro (log)

//...
use Monolog\Logger;
use Monolog\Handler\StreamHandler;
//..
$logger = new Logger('foo');
$logger->pushHandler(new StreamHandler('Resources/logs/main.log', Logger::DEBUG));
$cnovaSdk->setLogger($logger);

Console

Lista de comandos disponíveis:

./bin/main

Você pode verificar suas credenciais Cnova na linha de comando:

./bin/main credential

Você poder criar um arquivo chamado app.json com suas configurações personalizadas, as quais serão utilizadas na linha de comando:

Utilize como modelo o arquivo app.json.dist

Dica: Verifique os logs gerados em Resources/logs/main.log

Links

• Cnova-sdk Composer Package no packagist.org
• Documentação Oficial da API V2
• Marketplace-bundle Composer Package - Integração deste pacote com Symfony
• Outras SDKs para o Ecommerce do Brasil

Desenvolvimento

git clone --depth=1  [email protected]:gpupo/cnova-sdk.git
cd cnova-sdk;
ant;

Personalize a configuração do phpunit:

cp phpunit.xml.dist phpunit.xml;

Personalize os parâmetros!

Dica: Verifique os logs gerados em var/log/main.log

Propriedades dos objetos

Todo

Propriedades dos objetos

CnovaSdk\Client\Client

• [x] Sucesso ao definir options
• [x] Gerencia uri de recurso
• [ ] Objeto request possui header
• [ ] Acesso a lista de pedidos
• [ ] Acesso a lista de produtos

CnovaSdk\Entity\Order\Customer\Customer

• [x] É propriedade de order
• [x] Possui objeto phones

CnovaSdk\Entity\Order\Customer\Phones\Phone

• [x] Possui numero
• [x] Possui identificação de tipo

CnovaSdk\Entity\Order\Items\Items

• [x] Possui coleção de objetos product
• [x] Possui ids diferentes para cada unidade mesmo com skus iguais
• [x] Contém lista de ids existentes na coleção

CnovaSdk\Entity\Order\Items\Product\Product

• [x] Possui um identificador por unidade
• [x] Possui identificador do sku

CnovaSdk\Entity\Order\Manager

• [x] Obtem lista pedidos
• [x] Obtém a lista de pedidos recém aprovados e que esperam processamento
• [x] Recupera informacoes de um pedido especifico
• [x] Move pedido para status enviado
• [x] Falha ao mover pedido para enviado sem informações completas
• [x] Move pedido para status recebido
• [x] Move pedido para status cancelado

CnovaSdk\Entity\OrderCollection

• [x] Cada elementoÉ um objeto order
• [x] Cada elemento possui dados corretos
• [x] É um objeto metadata container
• [x] Possui objeto metadata
• [x] Possui propriedade indicadora de quantidade de registros

CnovaSdk\Entity\Order\Order

• [x] Cada item de uma lista e um objeto
• [x] Cada pedido possui objeto billing
• [x] Cada pedido possui objeto cliente
• [x] Cada pedido possui objeto frete
• [x] Cada pedido possui objeto contendo endereco de entrega
• [x] Cada pedido possui colecao de rastreamentos
• [x] Cada pedido possui colecao de produtos

CnovaSdk\Entity\Order\Trackings\Tracking\Invoice

• [x] Possui cnpj
• [x] Possui chave de acesso

CnovaSdk\Entity\Order\Trackings\Tracking\Tracking

• [x] Valida
• [x] Possui lista de items
• [x] Possui dados da transportadora
• [x] Inválido com rastreamento ausente
• [x] Inválido com nota fiscal ausente
• [x] Inválido com transportadora ausente
• [x] Válido com dados completos
• [x] Possui formato para atualização de order

CnovaSdk\Entity\Product\Loads\Loads

• [x] Possui colecao de products
• [x] Cada product possui status
• [x] Possui objeto metadata

CnovaSdk\Entity\Product\Loads\Manager

• [x] Obtem lista de situacoes de produtos
• [x] Permite acesso a lista de produtos com erro

CnovaSdk\Entity\Product\Loads\Metadata

• [x] É uma collection
• [x] Metadata possui quantidade de objetos enviados
• [x] Metadata possui informacao do offset atual
• [x] Metadata possui informacao do limit atual

CnovaSdk\Entity\Product\Manager

• [x] É o administrador de produtos
• [x] Possui objeto pool
• [x] Possui objeto client
• [x] Obtem lista de produtos cadastrados
• [x] Recupera informacoes de um produto especifico a partir de id
• [x] Guarda produtos em uma fila para gravacao em lote
• [x] Gerencia gravacao de produtos em lote
• [x] Atualiza preco e estoque de um produto
• [x] Nao executa atualizacao em produto inalterado
• [x] Atualiza apenas estoque em caso de ser o unico atributo alterado

CnovaSdk\Entity\Product\Price

• [x] É propriedade de product
• [x] Possui preço de
• [x] Possui preço por
• [x] Entrega parâmetros para atualização de preço do sku

CnovaSdk\Entity\Product\ProductCollection

• [x] Possui coleção de products
• [x] É um objeto metadata container
• [x] Possui objeto metadata
• [x] Possui propriedade indicadora de quantidade de registros

CnovaSdk\Entity\Product\Product

• [x] Possui propriedades e objetos
• [x] Possui uma colecao attributes
• [x] Possui objeto price
• [x] Possui objeto stock
• [x] Possui objeto dimensions
• [x] Possui objeto gift wrap
• [x] Entrega json

CnovaSdk\Entity\Product\Stock

• [x] É propriedade de product
• [x] Possui quantidade
• [x] Possui tempo preparação do produto
• [x] Entrega parâmetros para atualização de estoque do sku

CnovaSdk\Factory

• [x] Centraliza acesso a managers
• [x] Centraliza criacao de objetos

Lista de dependências (libraries)