2017 © Pedro Peláez
 

library wefact

Wefact 2.7 API Implementation

image

hyperized/wefact

Wefact 2.7 API Implementation

  • Sunday, January 7, 2018
  • by hyperized
  • Repository
  • 6 Watchers
  • 16 Stars
  • 1,614 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 12 Forks
  • 1 Open issues
  • 13 Versions
  • 19 % Grown

The README.md

Hostfact API 3.0 for Laravel

FOSSA Status, (*1)

Official documentation:

Installation

Install using composer:, (*2)

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., (*3)

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, (*4)

Hyperized\Hostfact\HostfactServiceProvider::class,

Register an alias for Hostfact, also in config/app.php:, (*5)

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

Now publish the Hostfact package into your installation:, (*6)

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

This should give you a message like: Copied File [/vendor/hyperized/hostfact/config/Hostfact.php] To [/config/Hostfact.php], (*7)

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, (*8)

// 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

Functionality

When writing code for this Hostfact package, consider that this package has been written as a basic interface., (*9)

This package will do the following:, (*10)

  • Provide an easy way to communicate with Hostfact API controllers;
  • Document the available API controller endpoints with methods;
  • Transport layer (HTTP/HTTPS) error catching;
  • Basic error parsing;

This package will not:, (*11)

  • Parameter / input validation;
  • Output validation;

You will need to consult the Hostfact API documentation to understand the acceptable input and output for each of the API controllers., (*12)

Examples

Example code:, (*13)

use \Hyperized\Hostfact\Api\Controllers\Product;

$products = Product::new()
                ->list([
                    'searchfor' => 'invoice'
                ]);

License

FOSSA Status, (*14)

The Versions

07/01 2018

dev-master

9999999-dev

Wefact 2.7 API Implementation

  Sources   Download

MIT

The Requires

 

The Development Requires

by Gerben Geijteman

wefact wefact-api

07/01 2018

dev-hyperized-patch-1

dev-hyperized-patch-1

Wefact 2.7 API Implementation

  Sources   Download

MIT

The Requires

 

The Development Requires

by Gerben Geijteman

wefact wefact-api

18/10 2017

v2.7.0

2.7.0.0

Wefact 2.7 API Implementation

  Sources   Download

MIT

The Requires

 

The Development Requires

by Gerben Geijteman

wefact wefact-api

05/09 2016

v2.3.9

2.3.9.0

Wefact 2.3 API Implementation

  Sources   Download

MIT

The Requires

 

The Development Requires

by Gerben Geijteman

25/05 2016

v2.3.8

2.3.8.0

Wefact 2.3 API Implementation

  Sources   Download

MIT

The Requires

 

The Development Requires

by Gerben Geijteman

25/04 2016

v2.3.7

2.3.7.0

Wefact 2.3 API Implementation

  Sources   Download

MIT

The Requires

 

The Development Requires

by Gerben Geijteman

17/04 2016

v2.3.6

2.3.6.0

Wefact 2.3 API Implementation

  Sources   Download

MIT

The Requires

 

The Development Requires

by Gerben Geijteman

16/04 2016

v2.3.4

2.3.4.0

Wefact 2.3 API Implementation

  Sources   Download

MIT

The Requires

 

The Development Requires

by Gerben Geijteman

16/04 2016

v2.3.3

2.3.3.0

Wefact 2.3 API Implementation

  Sources   Download

MIT

The Requires

 

The Development Requires

by Gerben Geijteman

14/02 2016

v2.3.2

2.3.2.0

Wefact 2.3 API Implementation

  Sources   Download

MIT

The Requires

 

The Development Requires

by Gerben Geijteman

08/02 2016

v2.3

2.3.0.0

WeFact 2.3 API Implementation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

by Gerben Geijteman

08/02 2016

v2.3.1

2.3.1.0

WeFact 2.3 API Implementation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

by Gerben Geijteman

09/06 2015

v2.2

2.2.0.0

WeFact 2.2 API Implementation

  Sources   Download

MIT

The Requires

  • php >=5.3.0

 

by Gerben Geijteman