README

ePost Global Shipping API Production Environment.
Built at 09/25/2024 12:43:58

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: Bearer
$config = Sinan\Epost\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Sinan\Epost\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Sinan\Epost\Api\AuthorizeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $apiInstance->apiV1AuthorizeValidateGet();
} catch (Exception $e) {
    echo 'Exception when calling AuthorizeApi->apiV1AuthorizeValidateGet: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AuthorizeApi	apiV1AuthorizeValidateGet	GET /api/v1/Authorize/Validate	Check to see if a token is valid
RateApi	apiV1RatePost	POST /api/v1/Rate
RateApi	apiV1RateServicesGet	GET /api/v1/Rate/Services	List all services.
ShipApi	apiV1ShipCloseGet	GET /api/v1/Ship/Close	Retrieve a list of Accounts that are ready to be closed.
ShipApi	apiV1ShipClosePost	POST /api/v1/Ship/Close	Initiate the end of day procedure.
ShipApi	apiV1ShipGet	GET /api/v1/Ship	Retrieve a list of packages sorted by most recent packages first.
ShipApi	apiV1ShipIdVoidGet	GET /api/v1/Ship/{id}/Void	Void a shipment. Required for reship.
ShipApi	apiV1ShipPost	POST /api/v1/Ship	Request a shipping label to be created.

Models

Authorization

Authentication schemes defined for the API:

Bearer

Type: API key
API key parameter name: Authorization
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: v1
- Generator version: 7.10.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

sinanulker / epost-global-php-client

Maintainers

Details