> For the complete documentation index, see [llms.txt](https://help.citrusad.com/retail-media-interface/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.citrusad.com/retail-media-interface/integration/de/data-api/api-overview/oauth-20-authentication.md).

# OAuth 2.0-Authentifizierung

{% hint style="info" %}
OAuth 2.0 ist nur auf dem Endpunkt /ads verfügbar

Wenn Sie das Bestell-Reporting über die API integrieren, müssen Sie den Endpunkt /orders mit Basic-Authentifizierung und Ihrem geheimen API-Schlüssel integrieren.
{% endhint %}

## Client-ID und Client-Secret

Die `client_id` und die `client_secret` werden von Ihrem Technical Account Manager bereitgestellt. Das Client-Secret ist vertraulich und sollte nicht weitergegeben werden.

## Anfordern von Access Tokens

Um ein Access Token zu erhalten, müssen Sie eine Anfrage senden, die die `client_id` und `client_secret`enthält. Dazu muss der Händler eine POST-Anfrage an den Epsilon Retail Media Autorisierungsserver-Endpunkt stellen:

```http
https://$BASE_URL/v1/oauth2/token
```

{% hint style="info" %}
`/oauth2/token` stellt nur das relevante Token bereit. Sie verwenden diese Token, um mit den verschiedenen Integrations-Endpunkten zu interagieren.
{% endhint %}

Ihre Anfrage erfordert eine Basic-Autorisierung, die über den Autorisierungs-Anfrage-Header gesendet wird und die des Händlers enthält `client_id` und `client_secret` Base64-codiert:

`Authorization: "Basic" + base64encode(client_id + ":" + client_secret)`

Sie müssen den folgenden Parameter unter Verwendung des Formats `application/x-www-form-urlencoded` im HTTP-Anfragetext hinzufügen:

`grant_type=client_credentials`

Die Anfrage sieht wie folgt aus:

```http
POST https://$BASE_URL/v1/oauth2/token
Content-Type: application/x-www-form-urlencoded
Authorization: Basic <base64 encoded id+key>
grant_type=client_credentials
```

## Erhalt Ihres Access Tokens

Die Antwort enthält die folgenden Informationen

* `access_token`: Das Access Token, das beim Aufruf der Epsilon Retail Media -APIs verwendet werden soll
* `expires_in`: Die Zeitspanne in Sekunden, bis das Access Token abläuft
* `token_type`: Der Typ des zurückgegebenen Tokens. In diesem Fall ist es immer Bearer

Eine Beispielantwort finden Sie unten

```json
{
  "access_token": "xxxxx.yyyyy.zzzzz",
  "expires_in": 3600,
  "token_type": "Bearer"
}
```

## Verwendung des Tokens

Aufrufe an die Epsilon Retail Media -API-Endpunkte können einfach durchgeführt werden, indem das generierte Access Token zum Autorisierungs-Header der Anfrage hinzugefügt wird `Authorization: “Bearer “ <access_token>`

```http
POST $BASE_URL/v1/ads/generate HTTP/1.1
accept: application/json
content-type: application/json
Authorization: Bearer <access_token>
{
    "customerId": "wertg5432a",
    "sessionId": "ec9-4e07-881d-3e9",
    "placement": "category",
    "catalogId": "628dbe95-2ec9-4e07-881d-3e9f92ab2e0b",
    "productFilters": [
         ["category:Cupboard/Snacks"]
    ],
    "options": {
                             "filterMode": "AndOr"
                             },
    "maxNumberOfAds": 3
}
```

## Anfragefehler

### Ungültiger Client

Wenn die `client_id` or `client_secret` in der Anfrage falsch ist, erhalten Sie eine Antwort wie diese:

```json
{
  "error": "invalid_client"
}
```

Stellen Sie sicher, dass Sie die korrekten Anmeldeinformationen verwenden. Überprüfen Sie Ihre `client_id` und `client_secret` und stellen Sie sicher, dass Sie die Basic-Autorisierung beim Aufruf des Endpunkts /token korrekt verwenden. ##Ungültige Anfrage Ein Fehler wegen einer ungültigen Anfrage wird vom Autorisierungsserver zurückgegeben, wenn der Anfrage ein erforderlicher Parameter fehlt, einen ungültigen Parameterwert enthält, einen Parameter mehr als einmal enthält oder anderweitig fehlerhaft ist.

```json
{
  "error": "invalid_request"
}
```

Stellen Sie sicher:

* Fügen Sie dem Anfragetext nur `grant_type=client_credentials` hinzu
* Legen Sie den richtigen `Content-Type` für den Anfrage-Header fest


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.citrusad.com/retail-media-interface/integration/de/data-api/api-overview/oauth-20-authentication.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
