hitmeister/suppliers-api-sdk

Suppliers API SDK

Maintainers

Details

github.com/hitmeister/suppliers-api-sdk

Homepage

Source

Issues

Installs: 47 185

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 9

Forks: 3

Open Issues: 0

0.15.0 2024-09-23 13:15 UTC

Requires

Requires (Dev)

MIT 2abd793d76a7e7ce726ab19836f3686ed26e72ba

phpapisdkswaggerreal.digitalsms.real

This package is auto-updated.

Last update: 2024-11-23 13:37:01 UTC

README

This documentation describes SMS Suppliers API. To be able use this API you should have an api-key and api-username

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

  • API versions: 1.11.1 & 2.0.0
  • Package version: 0.15.0
  • Build package: com.kaufland.swagger.codegen.CustomPhpClientCodegen

API versions

This SDK provides a way to communicate with both v1 AND v2 Suppliers APIs (see specific versions above). By default, version 1 is used. To change it, please use SMS\Suppliers\Configuration::getDefaultConfiguration()->setApiVersion($apiVersion) to set the API version (1 or 2) and make sure you then use the classes with the correct namespace to create your requests. Using a class of the wrong version could cause unexpected behaviour.

Ex: SMS\Suppliers\Api\InventoryApi for version 1 and SMS\Suppliers\Api\v2\InventoryApi for version 2

Older implementations of this SDK don't need to be changed for version 1.

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/hitmeister/suppliers-api-sdk.git"
    }
  ],
  "require": {
    "hitmeister/suppliers-api-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/suppliers-api-sdk/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 = SMS\Suppliers\Configuration::getDefaultConfiguration()->setApiKey('api-key', 'YOUR_PARAMETER_VALUE');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SMS\Suppliers\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-key', 'Bearer');
// Configure API key authorization: apiUsername
$config = SMS\Suppliers\Configuration::getDefaultConfiguration()->setApiKey('api-username', 'YOUR_PARAMETER_VALUE');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = SMS\Suppliers\Configuration::getDefaultConfiguration()->setApiKeyPrefix('api-username', 'Bearer');
// Set API version (1 or 2)
$config = SMS\Suppliers\Configuration::getDefaultConfiguration()->setApiVersion(1);

$apiInstance = new SMS\Suppliers\Api\InventoryApi(
    // 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
);
$id = "id_example"; // string | ID of inventory
$body = new \SMS\Suppliers\Model\CreateImportRequest(); // \SMS\Suppliers\Model\CreateImportRequest | Inventory import request which stores all the necessary info

try {
    $apiInstance->createImportRequest($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling InventoryApi->createImportRequest: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Version 1

Endpoints

All URIs are relative to https://sms.kaufland.de/api/v1/supplier

Models

Documentation for API Version 2

Endpoints

All URIs are relative to https://sms.kaufland.de/api/v2/supplier

Models

Documentation For Authorization

apiKey

  • Type: API key
  • API key parameter name: api-key
  • Location: HTTP header

apiUsername

  • Type: API key
  • API key parameter name: api-username
  • Location: HTTP header

Author

sms.tech@kaufland-online.com