Download the PHP package easypost/easypost-php without Composer
On this page you can find all versions of the php package easypost/easypost-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download easypost/easypost-php
More information about easypost/easypost-php
Files in easypost/easypost-php
Package easypost-php
Short Description EasyPost Shipping API Client Library for PHP
License MIT
Homepage https://github.com/EasyPost/easypost-php
Informations about the package easypost-php
EasyPost PHP Client Library
EasyPost, the simple shipping solution. You can sign up for an account at https://easypost.com.
Install
NOTE: This library relies on the mbstring extension. Ensure you have it installed correctly before using the library.
Usage
A simple create & buy shipment example:
HTTP Hooks
Users can subscribe to HTTP requests and responses via the RequestHook
and ResponseHook
objects. To do so, pass a function to the subscribeToRequestHook
or subscribeToResponseHook
methods of an EasyPostClient
object:
You can also unsubscribe your functions in a similar manner by using the unsubscribeFromRequestHook
and unsubscribeFromResponseHook
methods of a client object.
Documentation
API documentation can be found at: https://docs.easypost.com.
Library documentation can be found on the web at: https://easypost.github.io/easypost-php/ or by building them locally via the make docs
command.
Upgrading major versions of this project? Refer to the Upgrade Guide.
Support
New features and bug fixes are released on the latest major release of this library. If you are on an older major release of this library, we recommend upgrading to the most recent release to take advantage of new features, bug fixes, and security patches. Older versions of this library will continue to work and be available as long as the API version they are tied to remains active; however, they will not receive updates and are considered EOL.
For additional support, see our org-wide support policy.
Development
Testing
The test suite in this project was specifically built to produce consistent results on every run, regardless of when they run or who is running them. This project uses VCR to record and replay HTTP requests and responses via "cassettes". When the suite is run, the HTTP requests and responses for each test function will be saved to a cassette if they do not exist already and replayed from this saved file if they do, which saves the need to make live API calls on every test run. If you receive errors about a cassette expiring, delete and re-record the cassette to ensure the data is up-to-date.
Sensitive Data: We've made every attempt to include scrubbers for sensitive data when recording cassettes so that PII or sensitive info does not persist in version control; however, please ensure when recording or re-recording cassettes that prior to committing your changes, no PII or sensitive information gets persisted by inspecting the cassette.
Making Changes: If you make an addition to this project, the request/response will get recorded automatically for you when TestUtil::setupCassette('object/action.yml');
is added to the beginning of a test function. When making changes to this project, you'll need to re-record the associated cassette to force a new live API call for that test which will then record the request/response used on the next run.
Test Data: The test suite has been populated with various helpful fixtures that are available for use, each completely independent from a particular user with the exception of the USPS carrier account ID (see Unit Test API Keys for more information) which has a fallback value of our internal testing user's ID. Some fixtures use hard-coded dates that may need to be incremented if cassettes get re-recorded (such as reports or pickups).
Unit Test API Keys
The following are required on every test run:
EASYPOST_TEST_API_KEY
EASYPOST_PROD_API_KEY
Some tests may require an EasyPost user with a particular set of enabled features such as a Partner
user when creating referrals. We have attempted to call out these functions in their respective docstrings. The following are required when you need to re-record cassettes for applicable tests:
USPS_CARRIER_ACCOUNT_ID
(eg: one-call buying a shipment for non-EasyPost employees)PARTNER_USER_PROD_API_KEY
(eg: creating a referral user)REFERRAL_CUSTOMER_PROD_API_KEY
(eg: adding a credit card to a referral user)
Mocking
Some of our unit tests require HTTP calls that cannot be easily tested with live/recorded calls (e.g. HTTP calls that trigger payments or interact with external APIs).
We have implemented a custom, lightweight HTTP mocking functionality in this library that allows us to mock HTTP calls and responses.
A mock client is the same as a normal client, with a set of mock request-response pairs stored as a property.
At the time of making a real HTTP request, a mock client will instead check which mock request entry matches the queued request (matching by HTTP method and a regex pattern for the URL), and will return the corresponding mock response (HTTP status code and body).
NOTE: If a client is configured with a mocking utility, it will ONLY make mock requests. If it attempts to make a request that does not match any of the configured mock requests, the request will fail and trigger an exception.
To use the mocking utility: