Download the PHP package fulfillment/postage-api without Composer

On this page you can find all versions of the php package fulfillment/postage-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package postage-api

postage-api-php

A PHP library that wraps Fulfillment's Postage API for easy use

Features

Example

Installation

Configuration

Configuration needed is simple:

Optional Configurations:

There are two ways to configure OMS API

Use dotenv

Use a .env file compatible with fantastic phpdotenv library. Simply specify the absolute path to the folder containing your .env file as an argument in the OMS constructor.

An example file called .env.example can be found in the root directory.

Use an array

Alternatively, create an array with key/values matching the above specified configuration and pass it as an argument in the PostageClient constructor.

Usage

Passing Your Data To A Request Method

This package offers several options for data structures for use with the wrapper request methods:

Array

All wrapper methods accept a plain PHP array. If your data is already structured to produce a valid JSON body for a request you may simply pass it to a method.

Contracts

Contracts for Request models are available at

All wrapper methods will accept a corresponding model contract as an argument.

Abstract Models

These are abstract class models that implement the above mentioned contracts. If you wish to use an implemented contract but do not want to use the validation vendor or constructor used in the concrete models (you want to extend yourself) this what you want.

Located at

Concrete Models

These are ready-to-use classes with built in validation. Found at

Model Types

There are two types of models:

Request Models

Found at Fulfillment\Postage\Models\Request these are the models that are used when making any request that requires data (such as a POST or PUT request). They differ slightly from the other type (Response model) because they do not require as much data as is returned from the api.

Response Models

Found at Fulfillment\Postage\Models\Response these are the models that response json is parsed in to. They inherit from Request models and so can be reused to make requests. At this time there is no option to use your own implemented Response models for response hydration, but this is a feature in progress.

Validation

By default if the object passed into a method implements Validatable then it is validated before a request is sent (in the case of a POST or PUT request). A descriptive error will be thrown if a model has any validation failures.

There are two ways to configure this:

Roadmap

There's still lots to do, check the issues section to see what is being worked on or make a request.


All versions of postage-api with dependencies

PHP Build Version
Package Version
Requires respect/validation Version 1.1
netresearch/jsonmapper Version ^4.0.0
fulfillment/api-wrapper Version 0.2.0
foxxmd/php-utilities Version dev-master
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package fulfillment/postage-api contains the following files

Loading the files please wait ....