Download the PHP package fet/postcard-api without Composer

On this page you can find all versions of the php package fet/postcard-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?

Example code of fet/postcard-api

Informations about the package postcard-api

Introduction

The fet/postcard-api package is a PHP implementation of the Swiss Postcard API (see References).

Installation

To install this package, use Composer:

Make sure you have Composer installed on your system before running this command.

Configuration

Create a new Fet\PostcardApi\PostcardCreator instance using your API credentials:

Usage

Campaign

The campaign API allows you to retrieve information about your campaign. To interact with the campaign API, first obtain the campaign instance from the postcard creator:

Once you have the campaign instance, you can access its information using the following methods:

Postcard

To use the postcard API, you need to provide recipient and sender address details, the path to the front image of the postcard and the text to be printed on the postcard. Here's an example of how to do this:

The $recipient and $sender array have no required key/value pairs, but the $postcard instance will return errors and warnings if something went wrong.

Advanced usage

You can further manipulate the $postcard instance if you want:

The addBrandingText(), addBrandingImage(), and addBrandingQrTag() methods cannot be used in combination with each other, as they will overwrite each other's content. Choose one method to use for your postcard branding.

Approval

The postcard can only be approved if no errors are returned from the API. Otherwise, a Fet\PostcardApi\Exception\PostcardException.php exception will be thrown.

Handling warnings and errors

If there are warnings or errors returned from the API during the process of creating a postcard, you can retrieve them as follow:

Demo

Configuration

Before running the demo, you have to edit the examples/config.php file:

Running the demo in your browser

To launch a demo and see how the postcard API works in action, follow these steps:

  1. Start a local PHP development server by running the following command:

  2. Open your web browser and navigate to the following URL: http://localhost:8888/

Tests

Run the tests with:

References

Technical specifications

Swagger documentation

All versions of postcard-api with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
guzzlehttp/guzzle Version ^7.5
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 fet/postcard-api contains the following files

Loading the files please wait ....