Download the PHP package skay1994/shipment-sdk-php without Composer
On this page you can find all versions of the php package skay1994/shipment-sdk-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download skay1994/shipment-sdk-php
More information about skay1994/shipment-sdk-php
Files in skay1994/shipment-sdk-php
Package shipment-sdk-php
Short Description Este pacote é responsável por realizar o cálculo de cotações.
License MIT
Homepage https://github.com/melhorenvio/shipment-sdk-php
Informations about the package shipment-sdk-php
Shipment SDK - Serviço de cotações do Melhor Envio
Agora ficou mais fácil ter o serviço de cotações do Melhor Envio no seu projeto de e-commerce.
Índice
- Instalação
- Cofiguração Inicial
- Exemplos de uso
- Criação da calculadora
- Montando o payload da calculadora
- Adicionando CEPs de origem e destino
- Produtos
- Adicionando os produtos para cotação
- Pacotes
- Adicionando os pacotes para cotação
- Adicionando os serviços das transportadoras
- Adicionando serviços adicionais
- Retornando a cotação
- Mais exemplos
- Testes
- Changelog
- Contribuindo
- Segurança
- Créditos
- Licença
Dependências
require
- PHP >= 7.0
- Ext-json = *
- Guzzlehttp/guzzle >= 7.4
require-dev
- phpunit/phpunit >= 5
Instalação
Você pode instalar o pacote via composer, rodando o seguinte comando:
Configuração inicial
A instância criada de Shipment permite que você passe como parâmetros o seu token e o ambiente que você trabalhará, assim terá a autenticação pronta.
Lembrando que só será válido, se a criação do token pertencer ao mesmo ambiente passado como parâmetro.
Se você ainda não fez o processo de autorização, o Melhor Envio possui outro pacote para facilitar o processo. Você pode acessá-lo clicando aqui.
Criando a instância calculadora
Neste exemplo você criará uma instância para calculadora no seu código.
Montando o payload da calculadora
Adicionando CEPs de origem e destino
Nesta parte você deve definir os CEPs de origem e destino respectivamente.
Produtos
Adicionando os produtos para cotação
Nesta parte, você irá definir os produtos que servirão para a sua cotação as informações que devem ser passadas como parâmetro são as seguintes:
- Altura
- Largura
- Comprimento
- Peso
- Valor segurado
- Quantidade
Lembrando que o valor segurado por padrão deve ser o valor do produto.
Pacotes
Adicionando os pacotes para cotação
Nesta parte, você irá definir os pacotes que servirão para sua cotação, as informações que devem ser passadas como parâmetro são as seguintes:
- Altura
- Largura
- Comprimento
- Peso
- Valor segurado
As dimensões sempre devem ser passadas em centímetros e o peso em quilogramas. São as unidades que o Melhor Envio opera.
Lembrando que o valor segurado por padrão deve ser o valor do produto em Reais.
É importante ressaltar que os métodos de PACOTES e PRODUTOS não poderão ser utilizados conjuntamente, devendo ser utilizado apenas um ou outro.
Adicionando os serviços das transportadoras
Se você desejar customizar, nesta parte serão escolhidos os serviços das transportadoras que você deseja utilizar. Hoje, no Melhor Envio, estão disponíveis:
- Correios
- Jadlog
- Via Brasil
- Azul Cargo
- Latam Cargo
Adicionando serviços adicionais
Se você desejar customizar, pode configurar alguns serviços adicionais na sua cotação, são eles:
- Mão própria
- Aviso de recebimento
- Coleta
Lembrando que a adição desses serviços podem gerar acréscimos no preço na hora da cotação.
Retornando as informações da cotação
Aqui você retornará as informações do payload montado.
Mais exemplos
Aqui você pode acessar mais exemplos de implementação
Testes
Dentro do projeto você encontrará alguns documentos de teste baseados em testes unitários
Você pode usar na aplicação tanto o comando:
Quanto o comando:
Changelog
Consulte CHANGELOG para mais informações de alterações recentes.
Contribuindo
Consulte CONTRIBUTING para mais detalhes.
Segurança
Se você descobrir algum problema de segurança, por favor, envie um e-mail para [email protected], ao invés de usar um issue tracker.
Créditos
Licença
Melhor Envio. Consulte Arquivo de lincença para mais informações.