---
title: "Webservice"
manual: "Universal Messenger"
version: "main"
permalink: "https://docs.typo3.org/permalink/universal_messenger:configuration-webservice@main"
source: "Configuration/Webservice.rst"
rendered: "2026-10-07T12:03:11+00:00"
---

# Webservice {#configuration-webservice}

## API endpoint {#configuration-webservice-api-endpoint}

To access the Universal Messenger API, store the connection configuration
in [`additional.php`](https://docs.typo3.org/m/typo3/reference-coreapi/14.3/en-us/Configuration/Typo3ConfVars/Index.html#file-project-config-system-additional-php), under `TYPO3_CONF_VARS` \>
`EXTENSIONS` \> `universal_messenger` (note the spelling, it uses the
extension key, not the Composer package name).

**config/system/additional.php**

```php
// The Universal Messenger API endpoint
$GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['universal_messenger'] = array_merge(
    $GLOBALS['TYPO3_CONF_VARS']['EXTENSIONS']['universal_messenger'] ?? [],
    [
        'apiUrl'    => 'YOUR-API-URL',
        'apiKey'    => 'YOUR-API-KEY',
        'apiSecret' => 'YOUR-API-SECRET',
    ]
);
```

-   **apiUrl**

    -   *type:* string
    -   *Required:* true

    Your Universal Messenger API URL, the basis of all requests, for
    example `https://your-domain.td.universal-messenger.de/p`.

-   **apiKey**

    -   *type:* string
    -   *Required:* true

    The public key of your Universal Messenger API key, used as the HTTP
    basic authentication username.

-   **apiSecret**

    -   *type:* string
    -   *Required:* true

    The secret key of your Universal Messenger API key, used as the HTTP
    basic authentication password.

> [!IMPORTANT]
> The Universal Messenger REST API is not versioned on the client side,
> the authentication scheme depends on the Universal Messenger server
> version. API-key basic authentication requires a Universal Messenger
> server **7.56.0 or later**. The `umopen`/`cmsbs.open` token is
> deprecated since UM 7.41 and works only transitionally, older servers
> require the 2.x line of this extension and of the underlying [SDK](https://github.com/netresearch/sdk-api-universal-messenger).

Create the API key in the Universal Messenger backend, under the API key
management for your account.

## API logging {#configuration-webservice-logging}

To log Universal Messenger API requests and responses, enable
[enableLogging](https://docs.typo3.org/permalink/universal_messenger:confval-enablelogging@main) (see [Extension configuration](https://docs.typo3.org/permalink/universal_messenger:configuration-extension-configuration@main))
and add a log writer configuration to [`ext_localconf.php`](https://docs.typo3.org/m/typo3/reference-coreapi/14.3/en-us/ExtensionArchitecture/FileStructure/ExtLocalconf.html#file-extension-ext-localconf-php):

**ext_localconf.php**

```php
$GLOBALS['TYPO3_CONF_VARS']['LOG']['Netresearch']['UniversalMessenger']['writerConfiguration'] = [
    \Psr\Log\LogLevel::DEBUG => [
        \TYPO3\CMS\Core\Log\Writer\FileWriter::class => [
            'logFileInfix' => 'universal_messenger',
        ],
    ],
];
```