Download the PHP package ctwillie/laravel-usps without Composer
On this page you can find all versions of the php package ctwillie/laravel-usps. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download ctwillie/laravel-usps
More information about ctwillie/laravel-usps
Files in ctwillie/laravel-usps
Package laravel-usps
Short Description USPS API wrapper for Laravel 6 framework
License MIT
Informations about the package laravel-usps
Laravel-Usps
This package provides a very simple wrapper for the United States Postal Service API. Currently, this package only provides address validation features, but will soon comprise all features offered by the USPS API.
Prerequisites
Be sure to register at www.usps.com/webtools/ to receive your unique user ID from the United States Postal Service. This user ID is required to use this package.
Installation
Configuration
There are three important configurations.
-
Your USPS user ID:
- If you have not received your USPS user ID, follow the link in the prerequisites section to register with the United States Postal Service. It is required to use this package.
-
Whether you want SSL verification enabled for API requests:
- This setting is set to
true
by default for security reasons. You can override this behavior by setting theverrifyssl
config setting tofalse
. Do this at your own risk.
- This setting is set to
- Which environment you are working in:
- The options are
'local' and 'production'
which tell the package which API url to use, testing or production respectively. If no configuration is found forenv
, it will default to the environment recognized by laravel. This setting takes precedence overAPP_ENV
from your.env
file.
- The options are
We recommend placing all configuration settings in your .env
file and use Laravel's env()
helper function to access these values.
In config/services.php
add these three settings.
Usage
The current features offered by this package are:
- Address Validation
Address Validation
The Address
class handles creating and formatting address data. Pass the constructor an associative array of address details. Array keys are case-sensitive.
Below is an example of creating an address and making an api request for validation.
The USPS api supports up to 5 address validations per request. If you need to validate more than one address at a time, pass an array of addresses to the Address
constructor.
The response will contain the corrected address, or an error if not enough information was given or the address does not exists.
Response Formatting
You can specify the format of the response by passing an optional, case-insensitive parameter to the validate method. The default format is an associative array.
Contributing
Contributions are always welcomed and will receive full credit.
We accept contributions via Pull Requests on Github.
Authors
- Cedric Twillie
See also the list of contributors who participated in this project.
License
This project is licensed under the MIT License - see the LICENSE.md file for details
All versions of laravel-usps with dependencies
spatie/array-to-xml Version ^2.11
guzzlehttp/guzzle Version ~6.0