Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shipengine/shipengine-php
The official PHP SDK for ShipEngine API
https://github.com/shipengine/shipengine-php
address-normalization address-validation dhl-api fedex-api package-tracking php rest-api sdk shipengine shipment-tracking shipping-api shipping-cost shipping-label shipping-rates tracking-number ups-api usps-api
Last synced: about 20 hours ago
JSON representation
The official PHP SDK for ShipEngine API
- Host: GitHub
- URL: https://github.com/shipengine/shipengine-php
- Owner: ShipEngine
- License: apache-2.0
- Created: 2020-11-02T18:26:51.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-15T20:00:23.000Z (about 1 month ago)
- Last Synced: 2024-12-18T18:07:37.702Z (9 days ago)
- Topics: address-normalization, address-validation, dhl-api, fedex-api, package-tracking, php, rest-api, sdk, shipengine, shipment-tracking, shipping-api, shipping-cost, shipping-label, shipping-rates, tracking-number, ups-api, usps-api
- Language: PHP
- Homepage: https://www.shipengine.com/docs/
- Size: 801 KB
- Stars: 15
- Watchers: 17
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://shipengine.com)
ShipEngine PHP
==============
[](https://github.com/ShipEngine/shipengine-php/actions)
[](https://coveralls.io/github/ShipEngine/shipengine-php?branch=main)
[](//packagist.org/packages/shipengine/shipengine)
[](//packagist.org/packages/shipengine/shipengine)
A PHP library built on the [ShipEngine API](https://shipengine.com) offering low-level access as well as convenience methods.
**Table of Contents**
- [Quick Start](#quick-start)
- [Examples](#examples)
- [Methods](#methods)
- [Class Objects](#class-objects)
- [Instantiate ShipEngine Class](#instantiate-shipengine-class)
- [Testing](#testing)
- [Linting](#linting)
- [Contributing](#contributing)
Quick Start
===========
Install ShipEngine via [Composer](https://getcomposer.org/):
```bash
composer require shipengine/shipengine
```
- The only configuration requirement is an [API Key](https://www.shipengine.com/docs/auth/#api-keys).
> The following example assumes that you have already set the `SHIPENGINE_API_KEY` environment variable with your Api Key using `putenv()`.
Examples
========
Methods
-------
- [validateAddress](./docs/addressValidateExample.md "Validate Address method documentation") - Indicates whether the provided address is valid. If the
address is valid, the method returns a normalized version of the address based on the standards of the country in
which the address resides.
- [normalizeAddress](./docs/normalizeAddressExample.md "Normalize Address method documentation") - Returns a normalized, or standardized, version of the
address. If the address cannot be normalized, an error is returned.
- [trackPackage](./docs/trackPackageExample.md "Track Package method documentation") - Track a package by `packageId` or by `carrierCode` and `trackingNumber`. This method returns
the all tracking events for a given shipment.
Class Objects
-------------
- [ShipEngine]() - A configurable entry point to the ShipEngine API SDK, this class provides convenience methods
for various ShipEngine API Services.
Instantiate ShipEngine Class
----------------------------
```php
$apiKey,
'pageSize' => 75,
'retries' => 3,
'timeout' => \DateInterval('PT60S')
);
$shipengine = new ShipEngine($config);
```
Testing
=======
- You can now run all tests using [PHPUnit](https://phpunit.de/):
_phpunit_
```bash
composer test
```
Linting
=======
You can utilize the `composer` script that runs **phpcs**, **phpstan**, and **php-cs-fixer**.
```bash
composer lint
```
Contributing
============
Contributions, enhancements, and bug-fixes are welcome! [Open an issue](https://github.com/ShipEngine/shipengine-php/issues)
on GitHub and [submit a pull request](https://github.com/ShipEngine/shipengine-php/pulls).
We are managing `php environment` with [Nix](https://nixos.org/download.html "Nix Website")
and [Direnv](https://direnv.net/docs/installation.html "Direnv Install page"), and we recommend downloading
them before contributing to this project.
- The quickest way to install Nix is to open a terminal and run the following command, make sure to follow the
instructions output by the installation script:
```bash
curl -L https://nixos.org/nix/install | sh
```
- Next, install `Direnv` using one of th methods outlined on their install page here:
[Direnv Installation](https://direnv.net/docs/installation.html "Direnv Install page")
- Lastly, you will need open your terminal and while this repository the current working directory and run `direnv allow`,
this will allow `direnv` to auto-load every time you navigate to the repo. This will automatically load the `Nix`
environment which is running the proper version of `PHP and Xdebug (PHP 7.4)` this repository supports/requires.
```bash
direnv allow
```
- You will need to `cd` out of the project directory after you first install `direnv` and run `direnv allow` from within
the project directory, and then `cd` back into the project directory for `direnv` to auto-load the `Nix` environment properly.
This project also makes use of `pre-commit hooks` to help run lint and tests at time of commit, to leverage this you will
need to install [pre-commit](https://pre-commit.com/#installation) and run the following command while in this repo:
```bash
pre-commit install
```