inventorus/api-php-sdk

This package is abandoned and no longer maintained. No replacement package was suggested.

Inventorus public API

v1.0.0 2016-08-30 11:23 UTC

This package is not auto-updated.

Last update: 2024-02-29 16:41:04 UTC


README

Inventorus

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.

  1. If you have not already installed Composer, install the latest version.
  2. 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:

  1. Use Composer to install the SDK. See the section "Installation".

  2. 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";
  3. Import the SDK client in your project:

    use Inventorus\InventorusClient;
  4. Instantiate the client:

    $client = new InventorusClient($yourApiKey);