README

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This PHP package is automatically generated by the Swagger Codegen project:

API version: v2
Package version: 4.2.1
Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/horrentotaal/hamstra-api/horrentotaal/hamstra-api.git"
    }
  ],
  "require": {
    "horrentotaal/hamstra-api/horrentotaal/hamstra-api": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/Horrentotaal/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

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 = Horrentotaal\HamstraApi\Configuration::getDefaultConfiguration()->setApiKey('apiKey', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Horrentotaal\HamstraApi\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apiKey', 'Bearer');

$apiInstance = new Horrentotaal\HamstraApi\Api\ConfigurationWizardApi(
    // 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
);
$language = "language_example"; // string | ISO 639-1 code for language. Currently supported: nl and fr

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

?>

Documentation for API Endpoints

All URIs are relative to https://staging.api.hamstraonline.vmcluster.nl

Class	Method	HTTP request	Description
ConfigurationWizardApi	configurationWizardGet	GET /api/configuration-wizard/getEmbedURL	Get embedurl for customer based on APIkey authentication
OrderApi	orderCreateOrderAsync	POST /api/order	Creates the order
OrderApi	orderOrderQuotationAsync	PUT /api/order/orderQuotation	Creates an order for the given quotation
OrderApi	orderSaveAsQuotation	PUT /api/order/saveAsQuotation	Creates a quotation for the given order
OrderApi	orderSaveOrderAsync	PUT /api/order/saveOrder	Creates or updates the order
OrderApi	orderUpdateOrderAsync	PUT /api/order	Updates the order
OrderApi	orderValidateAsync	POST /api/order/validate	Validate the order
ProductApi	productGetAvailableProducts	GET /api/product	Get the available products for the authenticated user
ProductApi	productGetById	GET /api/product/{productId}	Get the details of a given product
ProductApi	productGetBySku	GET /api/product/sku/{sku}	Get the product by product code
ProductApi	productGetConfigurationAsync	GET /api/product/{productId}/configuration
ProductApi	productGetConfigurationAsync_0	POST /api/product/{productId}/configuration
ProductApi	productGetValidationMessagesAsync	GET /api/product/validationMessages	Get the product option validation messages
QuotationApi	quotationDeleteQuotation	DELETE /api/quotation/DeleteQuotation/{id}	Delete a quotation
QuotationApi	quotationGetQuotationLines	GET /api/quotation/getquotationlines/{id}	Get the quotation lines by a given quotations
QuotationApi	quotationGetQuotations	GET /api/quotation/getquotations	Get the quotations

horrentotaal / hamstra-api

Maintainers

Details

README

Requirements

Installation & Usage

Composer

Manual Installation

Tests

Getting Started

Documentation for API Endpoints

Documentation For Models

Documentation For Authorization

apiKey

Author