casdr / wefact

Unofficial implementation of the WeFact API v2 for Laravel 5

Hostfact API 2.7 for Laravel 5+

Official documentation:

• Hostfact API 2.7
• Official API examples

Installation

Install using composer:

composer require hyperized/hostfact

This package supports Package Auto-Discovery (Laravel 5.5+) so it doesn't require you to manually add the ServiceProvider and alias.

If you are using a lower version of Laravel or not using Auto-Discovery you can add the Hostfact Service Provider to the config/app.php file

Hyperized\Hostfact\HostfactServiceProvider::class,

Register a alias for Hostfact, also in config/app.php:

'Hostfact'    => Hyperized\Hostfact\HostfactServiceProvider::class,

Now publish the Hostfact package into your installation:

php artisan vendor:publish --provider="Hyperized\Hostfact\HostfactServiceProvider" --tag="config"

This should give you a message like: Copied File [/vendor/hyperized/hostfact/src/config/Hostfact.php] To [/config/Hostfact.php]

It's possible to edit your configuration variables in the config/Hostfact.php file or you can use the HOSTFACT_URL and HOSTFACT_KEY environment variables to store sensitive information in the .env file

// config/Hostfact.php
'api_v2_url'		=> env('HOSTFACT_URL', 'https://yoursite.tld/Pro/apiv2/api.php'),
'api_v2_key'		=> env('HOSTFACT_KEY', 'token'),
'api_v2_timeout'	=> env('HOSTFACT_TIMEOUT', 20),

// .env/.env.example
HOSTFACT_URL=https://yoursite.tld/Pro/apiv2/api.php
HOSTFACT_KEY=token
HOSTFACT_TIMEOUT=20

Example code:

// Direct use
$product = new Hyperized\Hostfact\Types\Product();
$productParams = [
    'searchfor' => 'invoice'
];
$output = $product->list($productParams);

// Use in Controllers
use Hyperized\Hostfact\Types\Product;

class MyController extends Controller {
    public function getProducts()
    {
        $product = new Product();
        $productParams = [
            'searchfor' => 'invoice'
        ];
        return $product->list($productParams);
    }
}

License