# Product API PHP Software Development Kit

This article provides software development kit documentation for the Schier Product API written in the PHP language with optional Laravel support.

Table of Contents

# Requirements

  • PHP >= 7.4
  • Laravel >= 7.* (required to use Laravel specific features)

# Installation

To install this package via Composer (opens new window):

$ composer require schierproducts/schier-product-api
{
    "require": {
        "schierproducts/schier-product-api": "^1.0"
    }
}

Note

This package is still being actively developed on, so you may optionally choose to use the :dev-master so you can get the most up-to-date versions of this package

# Using the client

To instantiate a new instance of the Schier Product API client, you will create a new instance of the SchierProductApi class.

Be sure to pass the provided API key as an associative array:

use SchierProducts\SchierProductApi\ProductApiClient;

$products = new ProductApiClient([
    'api_key' => 'YOUR API KEY'
]);

# Other supported parameters

api_base string, default: https://api.schierproducts.com

If you are trying to connect to another environment other than the default production environment, define the base here. FOR TESTING ONLY!!!

api_version string, default: 1

Schier will always use the most recent version of the API. However if you are trying to connect to an older version, define it here.

# Laravel support

# Configuration

To set the API key that this package uses to authenticate your requests, add the following entry to your app's environment files:

SCHIER_PRODUCT_API_KEY=<YOUR API KEY>

Also see Basics - Authentication

# Other Variables
SCHIER_PRODUCT_API_BASE

If you are trying to connect to another environment other than the default production environment, define the base here. FOR TESTING ONLY!!!

SCHIER_PRODUCT_API_VERSION

Schier will always use the most recent version of the API. However if you are trying to connect to an older version, define it here.

# Package auto-discovery

Since this package has a minimum Laravel dependency version of 7.*, if you are using this package in a Laravel application, you should not have to register this package's service provider.

If you are for some reason not using auto-discovery, add the following code to your config/app.php file:

SchierProducts\SchierProductApi\SchierProductApiServiceProvider::class,

# Using the Facade

If you want to use the facade to quickly access the API, add the following code to your facades within the config/app.php file:

'ProductApi' => SchierProducts\SchierProductApi\Facades\ProductApi::class,

# Publish the package's settings to your application

This will publish this package's configuration file product-api.php to your application's config directory.

php artisan vendor:publish --provider="SchierProducts\SchierProductApi\SchierProductApiServiceProvider"

# Exceptions

While using this package, based on the server response, it is possible for your application to retrieve any of the following exceptions:

  • Exception\InvalidRequestException - The route/resource is not found
  • Exception\InvalidArgumentException - The provided parameters for the requested resource are incorrectly formatted or are not supported.
  • Exception\AuthenticationException - The API key is empty or is not correct
  • Exception\PermissionException - The API key is valid, but does not have permission to access the requested content
  • Exception\RateLimitException - Your use of the API has exceeded the defined the limit. Please wait before requesting additional content
  • Exception\ApiConnectionException - If the API service that provides the API cannot be reached
  • Exception\UnknownApiErrorException - A general, catch-all error for any other issues

# Lists

When a list of resources are retrieved from the API, they are parsed and returned within an instance of SchierProducts\SchierProductApi\Collection. This class exposes a few methods for you to sort through the results.

  • allItems() - Returns the entire array of objects.
  • offsetGet(3) - Returns the item at the index defined the index parameter
  • count() - Returns the integer of results in the array
  • isEmpty() - Returns a boolean if the result array is empty
  • first() - Assuming the list of resources is not empty, returns the first one
  • last() - Assuming the list of resources is not empty, returns the last one

# Resources

Below are a list of resources/data that you can retrieve via this package:

# Product Types

Also see Product Types.

# List of product types

(Assuming you have already called the constructor):

$productTypes = $productApiClient->productTypes->all();

// via the facade
$productTypes = \ProductApi::productTypes();

# A specific product type

(Assuming you have already called the constructor):

$samplingPort = $productApiClient->productTypes->retrieve('sampling_port');

// via the facade
$samplingPort = \ProductApi::productTypes()->retrieve('sampling_port');

# A list of products within a product type

$samplingPortProducts = $productApiClient->productTypes->products('sampling_port');

// via the facade
$samplingPortProducts = \ProductApi::productTypes()->products('sampling_port');

# A list of products from a product type

(Assuming you have already called the constructor):

$productTypes = $productApiClient->productTypes->all();
$firstProductType = $products->first();
$products = $firstProductType->products();

// via the facade
$productTypes = \ProductApi::productTypes();
$firstProductType = $products->first();
$products = $firstProductType->products();

# Products

Also see Products.

# List of products

(Assuming you have already called the constructor):

$products = $productApiClient->products->all();

// via the facade
$products = \ProductApi::products();

# Get a product by model number

(Assuming you have already called the constructor):

$products = $productApiClient->products->retrieve('8030-003-01');

// via the facade
$products = \ProductApi::products('8030-003-01');

Note

The information returned by this response can be somewhat large due to the inclusion of accessories, kitchen fixtures, etc.

# Collections

Also see Collections.

# List of collections

(Assuming you have already called the constructor):

$collections = $productApiClient->collections->all();

// via the facade
$collections = \ProductApi::collections();
# Available filters/parameters

only - string, string[]

Provide a single or array of keys to return only the collections identified by the such keys.

limit - integer, default 25

Limit the number of response that are returned. The default is 25 collections.

Also see Collections - Parameters.

# Get a collection and it's products

(Assuming you have already called the constructor):

$collection = $productApiClient->collections->retrieve('gb-1');

// via the facade
$collection = \ProductApi::collections()->retrieve('gb-1');
Last Updated: 3 months ago