namidad/laravel-usps

johnpaulmedina USPS API for Laravel 8

7.0.2 2020-06-23 16:47 UTC

This package is not auto-updated.

Last update: 2024-09-29 23:32:13 UTC


README

Laravel-USPS 是一个 composer 包,允许您集成 USPS 地址/货运 API。此包由 @author Vincent Gabriel 从 https://github.com/VinceG/USPS-php-api 转换而来。

  • 需要有效的 USPS API 用户名
  • 在 Laravel 7 上测试过

安装

首先通过 Composer 安装此包。请在终端运行以下命令

composer require johnpaulmedina/laravel-usps

Laravel 集成

对于 Laravel 5.5 及更高版本,此包将自动发现并注册。

要在 Laravel 5.4 项目中配置此功能,您需要添加服务提供者。打开 config/app.php,并将新项目添加到 providers 数组中。

Johnpaulmedina\Usps\UspsServiceProvider::class,

然后,您还必须在 config/app.php 中指定别名。将新项目添加到 Aliases 数组中。

'Usps' => Johnpaulmedina\Usps\Facades\Usps::class,

这将允许通过添加 Facade Use Usps; 来进行集成

Laravel 配置

config/services.php 中添加您的 USPS 用户名配置。

'usps' => [
		'username' => "XXXXXXXXXXXX",
		'testmode' => false,
	],

示例控制器使用

Laravel 完成的唯一方法是 Usps::validate,它在 vendor/johnpaulmedina/laravel-usps/src/Usps/Usps.php 中定义。由于此包是为内部使用开发的,我没有带来所有功能,但您非常欢迎贡献您需要的功能,我将合并它们。我建议查看 @VinceG 的原始 PHP-Wrapper USPS PHP-Api,因为我已将那些类转换并自动加载到 Usps.php 文件中。

<?php

namespace App\Http\Controllers;

use App\Http\Requests;
use Illuminate\Support\Facades\Request;
use Johnpaulmedina\Usps;

class USPSController extends Controller
{
    public function index() {
        return response()->json(
            Usps::validate( 
                Request::input('Address'), 
                Request::input('Zip'), 
                Request::input('Apartment'), 
                Request::input('City'), 
                Request::input('State')
            )
        );
    }

    public function trackConfirm() {
        return response()->json(
            Usps::trackConfirm( 
                Request::input('id')
            )
        );
    }

    public function trackConfirmRevision1() {
        return response()->json(
            Usps::trackConfirm( 
                Request::input('id'),
                'Acme, Inc'
            )
        );
    }
}

贡献者

@pdbreen @bredmor @scs-ben

@VinceG 原始 README.MD

USPS PHP API

此包装允许您执行一些基本的 USPS API 调用。当前支持的一些功能包括:

  • 运费计算器(国内外都支持)
  • 根据地址查找邮编
  • 根据邮编查找城市/州
  • 验证地址
  • 创建优先快递标签
  • 创建开放并分发快递标签
  • 创建国际快递标签(快递、优先、平邮)
  • 服务配送计算器
  • 确认跟踪

要求

  • PHP >= 7.2.5,并配置以下扩展
    • cURL
  • USPS API 用户名

作者