cdma-numiscorner/shopware-admin-api-client

This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API. For a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints add the query parameter `type=jsonapi`.

Maintainers

Details

github.com/cdma-numiscorner/shopware-admin-api-client

Homepage

Source

Issues

Installs: 1

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

1.0 2024-01-18 13:55 UTC

Requires

Requires (Dev)

unlicense b5836f1c99ebf391e8bab1a6f45c65331808b58b

phprestapisdkopenapiopenapitoolsopenapi-generator

This package is auto-updated.

Last update: 2024-10-18 15:27:13 UTC

README

This endpoint reference contains an overview of all endpoints comprising the Shopware Admin API.

For a better overview, all CRUD-endpoints are hidden by default. If you want to show also CRUD-endpoints add the query parameter type=jsonapi.

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/cdma-numiscorner/shopware-admin-api-client.git"
    }
  ],
  "require": {
    "cdma-numiscorner/shopware-admin-api-client": "*@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 OAuth2 access token for authorization: oAuth
$config = OpenAPI\ShopwareAdminApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oAuth
$config = OpenAPI\ShopwareAdminApiClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\ShopwareAdminApiClient\Api\AclRoleApi(
    // 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
);
$_response = '_response_example'; // string | Data format for response. Empty if none is provided.
$inline_object = new \OpenAPI\ShopwareAdminApiClient\Model\InlineObject(); // \OpenAPI\ShopwareAdminApiClient\Model\InlineObject

try {
    $result = $apiInstance->createAclRole($_response, $inline_object);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AclRoleApi->createAclRole: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost:8000/api

Models

Authorization

oAuth

  • Type: OAuth
  • Flow: password
  • Authorization URL: ``
  • Scopes:
    • write: Full write access

oAuth

  • Type: OAuth
  • Flow: application
  • Authorization URL: ``
  • Scopes:
    • write: Full write access

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: 6.5.8.0
    • Package version: 1.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen