inventorus / api-php-sdk
Inventorus public API
Requires
- php: >=5.4.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- mashape/unirest-php: ~3.0.1
This package is not auto-updated.
Last update: 2024-02-29 16:41:04 UTC
README
Inventorus PHP SDK
Welcome to Inventorus PHP SDK. This repository contains SDK and its documentation.
If you already have installed Composer, run composer require inventorus/api-php-sdk
to install Inventorus SDK.
Documentation
This repository contains brief documentation, we recommend reading extended version here.
To learn everything about responses and requests read API documentation.
For use cases please visit examples.
Installation
The SDK has dependencies over external libraries. These dependencies
are defined in the composer.json
file. To resolve these dependencies, we use
the Composer package manager. You will need internet access for this.
- If you have not already installed Composer, install the latest version.
- Once Composer is installed, from commandline, run
composer require inventorus/api-php-sdk
in your project folder.
Usage
For using this SDK do the following:
-
Use Composer to install the SDK. See the section "Installation".
-
Depending on your project setup, you might need to include composer's autoloader in your PHP code to enable autoloading of classes.
require_once "vendor/autoload.php";
-
Import the SDK client in your project:
use Inventorus\InventorusClient;
-
Instantiate the client:
$client = new InventorusClient($yourApiKey);