skizu/simpleapi

Simple api wrapper with easy caching and throttling

dev-master 2015-07-23 13:36 UTC

Requires

• php: >=5.4.0
• guzzlehttp/guzzle: ~5.2

Suggests

• laravel/framework: Required to use Cache without definition
• lumen/framework: Alternatively required to use Cache without definition

MIT

• Skizu

• php
• api
• wrapper
• laravel

README

A simple api wrapper with quick and easy caching and throttling.

Configuration

To configure a new api key you must register it in the .env where in the example EXAMPLE_KEY is the key.

# Required 
EXAMPLE_KEY_API_URL=http://api.example.com/

# Optional
EXAMPLE_KEY_API_THROTTLE_LIMIT=100
EXAMPLE_KEY_API_STORAGE_TIME=1440
EXAMPLE_KEY_API_CACHE_TIME=60

Usage

Example to resolve http://api.example.com/baz?foo=bar

$api = new SimpleAPI\RegisterAPI('example_key');

$query = [
	'foo' => 'bar'
];

$result = $api->action('baz')->lookup($query);

Error handling

This library works by throwing exceptions which you would need to catch.

• Invalid configuration ConfigException
• Throlled API ThrottleException
• Request error RequestException
• Response error ResponseException
• Server error ServerException