README

Division: Post & Parcel Germany
The INTERNETMARKE is the online-postage for mail products of Deutsche Post AG.

For more information, please visit https://www.deutschepost.de/de/i/internetmarke-porto-drucken/kundenservice/internetmarke/kontakt.html.

Installation & Usage

Requirements

PHP 8.1 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');




$apiInstance = new kruegge82\DPIM\Api\ApiVersionResourceApi(
    // 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()
);

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

API Endpoints

All URIs are relative to https://api-eu.dhl.com/post/de/shipping/im/v1

Class	Method	HTTP request	Description
ApiVersionResourceApi	apiVersion	GET /	Get information about this REST Api version.
AppResourceApi	chargeWallet	PUT /app/wallet	Charge users wallet
AppResourceApi	checkoutShoppingCartPDFApp	POST /app/shoppingcart/pdf	Checkouts ot the PDF shopping cart.
AppResourceApi	checkoutShoppingCartPNGApp	POST /app/shoppingcart/png	Checkouts ot the PNG shopping cart.
AppResourceApi	initShoppingCartApp	POST /app/shoppingcart	Initializes a shopping cart and returns the shopOrderId.
AppResourceApi	retoureVouchersApp	POST /app/retoure	Retoure vouchers For App.
AppResourceApi	retrieveCatalogApp	GET /app/catalog	Retrieve catalogs.
AppResourceApi	retrieveRetoureStateApp	GET /app/retoure	Retrieve retoure state for App.
AppResourceApi	retrieveShoppingCartApp	GET /app/shoppingcart/{shopOrderId}	Retrieves a shopping cart.
UserResourceApi	authorization	POST /user	Get authorization token.
UserResourceApi	retrieveUserData	GET /user/profile	Authenticate and retrieve authorized user's data for shop.

Models

Authorization

Authentication schemes defined for the API:

BearerAuth

Type: Bearer authentication

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: 1.27
- Generator version: 7.14.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

kruegge82 / deutschepost-internetmarke-php-sdk

Maintainers

Details