Skip to content

habitissimo/txerpa-php

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Txerpa

A basic library to represent the Txerpa REST API as a PHP class (see https://www.txerpa.com/info/api for more information about the Txerpa API).

This library presents all the Txerpa API operations as a PHP class, it uses exceptions to handle errors and it's written to handle errors in a consistent manner.

The Txerpa API has some particularities I don't like, for example, if you are performing a search, when the criteria matches some elements they will be presented as an array, but if there is no matches it will return a 404 instead of an empty collection, this library handles this exceptions to provide a consistent expirience, so instead of throwing an exception it will return an empty array when a collection is expected or null when a single object was expected.

Installation

Click the download link above or git clone git://github.com/habitissimo/txerpa-api.git

From the cloned directory do:

git submodule init
git submodule update

This will load the curl wrapper dependency on which this one relies.

Usage

First of all you have to specify your authentication credentials for the API.

cp config_sample.php config.php

Now edit config.php with your favorite editor and set the values for username and password.

define('TXERPAAPI_USERNAME', 'username');
define('TXERPAAPI_PASSWORD', 'secret');

Initialization

Simply require and initialize the Txerpa class like so:

require_once 'txerpa.php';
$txerpa = new Txerpa();

Performing a Request

$response = $txerpa->currencyAll();

Testing

Uses ztest, simply download it to path/to/txerpa-api/test/ztest (or anywhere else in your php include_path)

Then run test/runner.php

Contact

Problems, comments, and suggestions all welcome: hchinchilla@habitissimo.com

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages