canonical: https://jentic.com/apis/swaggerhub.apologistics-gmbh/banner-api

# Apologistics Gmbh Banner-API

REST API zum Abfragen und Manipulieren von Bannern und deren zeitlicher Planung. The API exposes 10 endpoints secured with bearer authentication.

## For AI agents

Programmatically abrufen aller banner, abruf der geplanten banner des shops. Covers 10 operations with bearer authentication.

## Scope

Does not handle payments, communications, or crm - use for developer tools only.

## Capabilities

- Abrufen aller Banner
- Abruf der geplanten Banner des Shops
- Anlegen eines neuen Banners
- Überschreiben von Attributen eines spezifischen Banners
- Löschen eines spezifischen Banners

## Use cases

### Developer Tools Operations

Use the Banner-API to perform developer tools operations programmatically. The API provides 10 endpoints covering core functionality including abrufen aller banner, abruf der geplanten banner des shops, anlegen eines neuen banners.

Example prompt: Call GET /Banners to abrufen aller banner

### Automated Abruf aller Banner Management

Automate abruf aller banner operations by combining multiple Banner-API endpoints. Agents can abruf der geplanten banner des shops and then anlegen eines neuen banners in a single workflow.

Example prompt: Call GET /BannerSchedules to abruf der geplanten banner des shops, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Banner-API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'abrufen aller banner', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/Banners` | Abrufen aller Banner |
| GET | `/BannerSchedules` | Abruf der geplanten Banner des Shops |
| POST | `/Banner` | Anlegen eines neuen Banners |
| GET | `/Banner/{id}` | Abruf aller Attributes eines spezifischen Banners |
| PUT | `/Banner/{id}` | Überschreiben von Attributen eines spezifischen Banners |
| DELETE | `/Banner/{id}` | Löschen eines spezifischen Banners |
| POST | `/BannerSchedule` | Anlegen einer neuen Zeitplanung für einen Banner |
| GET | `/BannerSchedule/{id}` | Zeitplanung abrufen |

## Key resources

- **Abruf aller Banner** — Operations related to Abruf aller Banner
- **Abruf aller Zeitpläne** — Operations related to Abruf aller Zeitpläne
- **Banner erstellen/bearbeiten/löschen** — Operations related to Banner erstellen/bearbeiten/löschen
- **Zeitplan erstellen/bearbeiten/löschen** — Operations related to Zeitplan erstellen/bearbeiten/löschen

## Why Jentic

- **Setup:** Wiring the Banner-API by hand means handling its JWT bearer auth, tracking the banner and schedule id paths, and formatting each create, update, and delete call yourself. Through Jentic you install once, import the Banner-API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** This API puts the banner id in the URL path (`/Banner/{id}`), so a rule can pin your agent to one banner: it can read and update that banner and nothing else. You choose the operations it may call, so destructive ones like deleting a banner are not included unless you add them.
- **Credential handling:** Your Banner-API token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list all banners' or 'schedule a banner', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Github** — Alternative developer tools API
- **Gitlab** — Alternative developer tools API

## FAQ

### What authentication does the Banner-API use?

The Banner-API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I abrufen aller banner with the Banner-API?

Yes. Use the GET /Banners endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Banner-API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I abrufen aller banner through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'abrufen aller banner'. Jentic returns the matching Banner-API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Banner-API have?

The Banner-API exposes 10 endpoints covering abruf aller banner, abruf aller zeitpläne, banner erstellen/bearbeiten/löschen operations.

### Can I limit what my agent is allowed to do with the Banner-API?

Yes. Because you run Jentic One yourself, you decide which Banner-API operations the agent may call, so read-only work like GET /Banners and GET /BannerSchedules can be allowed while destructive calls such as DELETE `/Banner/{id}` stay off unless you add them. Since the banner id sits in the URL path (`/Banner/{id}`), your own rules can pin the agent to a single banner, letting it read and update that one banner and nothing else. The token that authorizes these calls is held by your instance and never enters the agent's context, so the agent can act only within the operations you have granted.
