canislupus/api-client-melhor-envio

Client for Melhor Envio API

0.1.1 2023-10-12 16:40 UTC

Requires

• php: ^8.1
• ext-json: *
• guzzlehttp/guzzle: ^7

MIT

• Leonardo de Aguiar

• ecommerce
• api
• client
• shipments
• melhor envio
• canis lupus

README

Cliente para integração com a API do sistema Melhor Envio. Conheça o Melhor Envio

Instalação

Composer

composer require canislupus/api-client-melhor-envio

Utilização

use CanisLupus\ApiClients\MelhorEnvio\v2\MelhorEnvioApiClient;
use CanisLupus\ApiClients\MelhorEnvio\v2\Enums\EnvironmentEnum;
use CanisLupus\ApiClients\MelhorEnvio\v2\MelhorEnvioApiConfig;
use CanisLupus\ApiClients\MelhorEnvio\v2\Exceptions\MelhorEnvioApiException;

$appName = 'Canis Lupus';
$appSupportEmail = '[e-mail]';
$token = '#TOKEN#';

// Inicialize o cliente passando um objeto de configuração
$clientMelhorEnvio = new MelhorEnvioApiClient(
    new MelhorEnvioApiConfig(EnvironmentEnum::Sandbox, $appName, $appSupportEmail, $token)
);

// Exemplo para Cotação de Frete
try {    
    $fretes = $clientMelhorEnvio->shipment->calculate([
        'from' => ['postal_code' => "36085400"],
        'to' => ['postal_code' => "36025007"],
        'products' => [
            [
                'id' => 1,
                'width' => 10,
                'height' => 10,
                'length' => 10,
                'weight' => 1,
                'insurance_value' => 200,
                'quantity' => 1
            ]
        ]
    ]);

    $fretesComValor = [];
    foreach ($fretes as $frete) {
        if ($frete->getError()) continue;

        $fretesComValor[] = [
            'empresa' => $frete->getCompany()->getName(),
            'servico' => $frete->getServiceName(),
            'preco' => $frete->getPrice(),
            'prazoEntrega' => $frete->getDeliveryTime() . ' dias úteis'
        ];
    }
    echo "<pre>";
    var_dump($fretesComValor);
    echo "</pre>";
    die;

} catch (MelhorEnvioApiException $e) {
    die($e->getMessage());
}

Mais exemplos

Mais exemplos podem ser encontrados na pasta docs/examples

Abrangência

Total de Endpoints	34
Total de Endpoints abrangidos	7
Percentual abrangido	20,58%

Lista de API's

Grupo	Recurso	Situação
Autenticação	[POST] Solicitação do token	0%
Autenticação	[GET] Listar informações de aplicativo	0%
Cotação	[POST] Cálculo de Fretes	100%
Criando envios	[POST] Inserir fretes no carrinho	0%
Criando envios	[GET] Listar itens do carrinho	0%
Criando envios	[GET] Exibir informações de item do carrinho	0%
Criando envios	[DELETE] Remoção de itens do carrinho	0%
Etiquetas	[POST] Geração de etiquetas	0%
Etiquetas	[POST] Impressão de etiquetas	0%
Etiquetas	[POST] Pré-visualização de etiquetas	0%
Pagamento de envios	[POST] Compra de fretes	0%
Pesquisa, listagem e cancelamento de etiquetas	[GET] Pesquisar etiqueta	0%
Pesquisa, listagem e cancelamento de etiquetas	[GET] Listar etiquetas	0%
Pesquisa, listagem e cancelamento de etiquetas	[GET] Listar informações de uma etiqueta	0%
Pesquisa, listagem e cancelamento de etiquetas	[POST] Verificar se etiqueta pode ser cancelada	0%
Pesquisa, listagem e cancelamento de etiquetas	[POST] Cancelamento de etiquetas	0%
Pesquisa, listagem e cancelamento de etiquetas	[POST] Rastreio de envios	0%
Listagem de transportadoras, serviços e agências	[GET] Listar transportadoras	100%
Listagem de transportadoras, serviços e agências	[GET] Listar informações de uma transportadora	100%
Listagem de transportadoras, serviços e agências	[GET] Listar serviços	100%
Listagem de transportadoras, serviços e agências	[GET] Listar informações de um serviço	100%
Listagem de transportadoras, serviços e agências	[GET] Listar agências (e opções de filtro)	100%
Listagem de transportadoras, serviços e agências	[GET] Listar informações de uma agência	100%
Informações do usuário	[GET] Listar informações do usuário	0%
Informações do usuário	[GET] Listar endereços do usuário	0%
Informações do usuário	[GET] Saldo do usuário	0%
Informações do usuário	[POST] Inserir saldo na carteira do usuário	0%
Cadastro e informações das lojas	[GET] Listar lojas do usuário	0%
Cadastro e informações das lojas	[POST] Cadastrar loja	0%
Cadastro e informações das lojas	[GET] Visualizar loja	0%
Cadastro e visualização de endereços e telefones de lojas	[POST] Cadastrar endereço de uma loja	0%
Cadastro e visualização de endereços e telefones de lojas	[GET] Listar endereços de uma loja	0%
Cadastro e visualização de endereços e telefones de lojas	[POST] Cadastrar telefones de uma loja	0%
Cadastro e visualização de endereços e telefones de lojas	[GET] Listar telefones de uma loja	0%

Licença

• MIT License