frenet/frenet-php

将您的PHP应用程序与Frenet API集成最简单的方式。

1.3.1 2022-11-03 17:39 UTC

README

这是官方的Frenet API集成PHP SDK。

Build Status Codacy Badge Codacy Badge

关于

这是Frenet API的官方SDK(软件开发工具包)。本SDK旨在帮助PHP系统和Frenet API集成。

安装

使用composer安装

要使用composer安装,您需要在您的计算机上安装composer,这样您就可以轻松地将此SDK安装到您的项目中。

一旦安装了composer,您只需要求此SDK

> composer require frenet/frenet-php

使用方法

要在您的PHP系统中开始使用此SDK非常简单。请查看下面的示例,了解如何轻松使用

<?php

/**
 * First we need to require the composer autoloader.
 */
require_once './vendor/autoload';

/**
 * This is your token from FRENET API.
 */
$token = '<YOUR TOKEN COMES RIGHT HERE>';

/** @var \Frenet\ApiInterface $api */
$api = \Frenet\ApiFactory::create($token);

/**
 * Here we will create a quote request for sending to API.
 * 
 * @var \Frenet\Command\Shipping\QuoteInterface $quote
 */
$quote = $api->shipping()->quote()
    ->setRecipientCountry('BR')
    ->setSellerPostcode('13015300')
    ->setRecipientPostcode('04011060')
    ->setShipmentInvoiceValue(100.87)
    ->addShippingItem('CWZ_75673_P', 1, 2.1, 14, 20, 15, 'Accessories')
    ->addShippingItem('CWZ_75673_F', 1, 2.1, 14, 20, 17, 'Accessories');

/**
 * The method `execute()` sends the request and parse the body result to a object type.
 * 
 * @var \Frenet\ObjectType\Entity\Shipping\QuoteInterface $result 
 */
$result = $quote->execute();
$services = $result->getShippingServices();

/** @var Frenet\ObjectType\Entity\Shipping\Quote\ServiceInterface $service */
foreach ($services as $service) {
    $price        = $service->getShippingPrice();
    $carrier      = $service->getCarrier();
    $deliveryTime = $service->getDeliveryTime();
    $responseTime = $service->getResponseTime();
    
    /** Do anything you want with this quotation. */
}