emgag/vg-wort-message-api

This package is abandoned and no longer maintained. No replacement package was suggested.

VG Wort METIS messages API helper

dev-master 2022-12-31 12:56 UTC

This package is auto-updated.

Last update: 2022-12-31 13:02:28 UTC


README

WARNING: This library is no longer maintained and doesn't work with the current VG Wort METIS API version.

A plugin to simplify the creation and submission of VG Wort METIS messages. Works with the official T.O.M. WebServices.

Installation

composer require emgag/vg-wort-message-api

Usage

MessageService

use Emgag\VGWort\MessageService;

$messageService = new MessageService($username, $password);

$response = $messageService->newMessage(
    $id, // Private Identification Id
    [
        // Multiple Authors possible
        ["firstName" => "", "surName" => "", "cardNumber" => ""]
    ],
    $title, // Title of this message
    $text, // Text of this message (plain text)
    $urls // URLs of this message
);

It's possible to provide multiple URLs. The URLs $urls could be in one of these formats:

  • As an simple array.
$urls = [
    "http://example.com/path/to/file.html"
];
  • As an multi-dimensional array. The keys will be ignored.
$urls = [
    "page-1" => [
        "http://example-1.com/path/to/file.html"
    ],
    "page-2" => [
        "http://example-2.com/path/to/file.html"
    ]
];

PixelService

use Emgag\VGWort\PixelService;

$pixelService = new PixelService($username, $password);

try {
    $ids = $pixelService->overview(PixelService::TYPE_MINDESTZUGRIFF);
} catch (\Exception $e) {
    ...
}

Allowed types:

  • PixelService::TYPE_MINDESTZUGRIFF
  • PixelService::TYPE_ANTEILIGER_MINDESTZUGRIFF

License

vg-wort-message-api is licensed under the MIT License.