README

Authentication

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: apiKey
$config = ProductApi\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = ProductApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new ProductApi\Api\CategoriesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$page = 1; // int | The collection page number

try {
    $result = $apiInstance->getCategoriesCollection($page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CategoriesApi->getCategoriesCollection: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
CategoriesApi	getCategoriesCollection	GET /api/categories	Retrieves the collection of Categories resources.
CategoriesApi	getCategoriesItem	GET /api/categories/{id}	Retrieves a Categories resource.
CategoriesApi	postCategoriesCollection	POST /api/categories	Creates a Categories resource.
CategoriesApi	putCategoriesItem	PUT /api/categories/{id}	Replaces the Categories resource.
CharacteristicApi	deleteCharacteristicItem	DELETE /api/characteristics/{id}	Removes the Characteristic resource.
CharacteristicApi	getCharacteristicCollection	GET /api/characteristics	Retrieves the collection of Characteristic resources.
CharacteristicApi	getCharacteristicItem	GET /api/characteristics/{id}	Retrieves a Characteristic resource.
CharacteristicApi	postCharacteristicCollection	POST /api/characteristics	Creates a Characteristic resource.
CharacteristicApi	putCharacteristicItem	PUT /api/characteristics/{id}	Replaces the Characteristic resource.
ProductTypeApi	getProductTypeCollection	GET /api/product-types	Retrieves the collection of product-type resources.
ProductTypeApi	getProductTypeItem	GET /api/product-types/{id}	Retrieves a product-type resource.
ProductTypeApi	postProductTypeCollection	POST /api/product-types	Creates a product-type resource.
ProductTypeApi	putProductTypeItem	PUT /api/product-types/{id}	Replaces the product-type resource.
ProductsApi	deleteProductsItem	DELETE /api/products/{id}	Removes the products resource.
ProductsApi	getProductsCollection	GET /api/products	Retrieves the collection of products resources.
ProductsApi	getProductsItem	GET /api/products/{id}	Retrieves a products resource.
ProductsApi	postProductsCollection	POST /api/products	Creates a products resource.
ProductsApi	putProductsItem	PUT /api/products/{id}	Replaces the products resource.
TokenApi	postCredentialsItem	POST /token/authorize
TokenApi	postRefreshToken	POST /token/refresh
UserApi	getUserCollection	GET /api/users	Retrieves the collection of User resources.
UserApi	getUserItem	GET /api/users/{id}	Retrieves a User resource.
UserApi	postUserCollection	POST /api/users	Creates a User resource.
UserApi	putUserItem	PUT /api/users/{id}	Replaces the User resource.

Models

Authorization

apiKey

Type: API key
API key parameter name: Authorization
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 0.0.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

cdma-numiscorner / product-api-client

Maintainers

Details