canonical: https://jentic.com/apis/weber-gesamtausgabe.de/weber-gesamtausgabe

# Weber Gesamtausgabe De WeGA API

⚠️<b>DEPRECATION WARNING</b>⚠️<br/>This version of the WeGA API specification is outdated and superseded by [version 1.1.0](https://weber-gesamtausgabe.de/api/v1/openapi.json). <br/> <br/> For feedback or requests about this API please contact stadler@weber-gesamtausgabe.de or start the discussion at https://github.com/Edirom/WeGA-WebApp. The API exposes 10 endpoints.

## For AI agents

Programmatically create a new wega id, get status information about the running wega-webapp. Covers 10 operations.

## Scope

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

## Capabilities

- Create a new WeGA ID
- Get status information about the running WeGA-WebApp
- Finds code samples by XML element
- Lists all documents
- Monitor WeGA API operational status and events

## Use cases

### CRM Operations

Use the WeGA API to perform crm operations programmatically. The API provides 10 endpoints covering core functionality including create a new wega id, get status information about the running wega-webapp, finds code samples by xml element.

Example prompt: Call GET `/application/newID` to create a new wega id

### Automated Documents Management

Automate documents operations by combining multiple WeGA API endpoints. Agents can get status information about the running wega-webapp and then finds code samples by xml element in a single workflow.

Example prompt: Call GET `/application/status` to get status information about the running wega-webapp, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call WeGA 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 none tokens manually.

Example prompt: Search Jentic for 'create a new wega id', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/application/newID` | Create a new WeGA ID |
| GET | `/application/status` | Get status information about the running WeGA-WebApp |
| GET | `/code/findByElement/{element}` | Finds code samples by XML element |
| GET | `/documents` | Lists all documents |
| GET | `/documents/findByAuthor/{authorID}` | Finds documents by author |
| GET | `/documents/findByDate` | Finds documents by date |
| GET | `/documents/findByMention/{docID}` | Finds documents by reference |
| GET | `/documents/{docID}` | Returns documents by ID |

## Key resources

- **Documents** — Access to the documents of the WeGA digital edition
- **Search** — Access to search functions of the WeGA digital edition
- **Code Samples** — Access to encoding features
- **Application** — Access to application settings
- **Facets** — Access to facets for filtering result sets

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 54 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 100 / 100
  - Developer Experience & Jentic Compatibility: 64 / 100
  - AI-Readiness & Agent Experience: 26 / 100
  - Agent Usability: 94 / 100
  - Security: 100 / 100
  - AI Discoverability: 64 / 100
- **View full report:** https://jentic.com/apis/weber-gesamtausgabe.de/weber-gesamtausgabe/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the WeGA API by hand means pointing at its host, tracking its document lookup paths, and handling responses yourself. Through Jentic you install once, import the WeGA API from the API Directory, configure it once, and your agent calls it.
- **Permission scoping:** WeGA puts the document id in the URL path (`/documents/{docID}`), so a rule can pin your agent to reading one document and nothing else. You choose the operations it may call, so anything beyond the reads you enable is not available.
- **Credential handling:** This read-only API needs no credential, so there is no secret to store. Any host value you configure stays in your own Jentic One instance and is injected at execution time, never entering the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'find documents by author' or 'get a document by id', and Jentic returns the matching WeGA operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Hubspot** — Alternative crm API
- **Salesforce** — Alternative crm API
- **Pipedrive** — Complementary crm API
- **Zoho** — Complementary crm API

## FAQ

### What authentication does the WeGA API use?

The WeGA API uses no authentication. 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 create a new wega id with the WeGA API?

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

### What are the rate limits for the WeGA 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 create a new wega id through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'create a new wega id'. Jentic returns the matching WeGA API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the WeGA API have?

The WeGA API exposes 10 endpoints covering documents, search, code samples operations.

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

Yes. Jentic One is self-hosted, so your own rules decide which WeGA operations the agent may call and which it may not. Because WeGA is read-only and puts the document ID in the URL path (GET `/documents/{docID}`), you can pin the agent to reading a single document, or allow only broader lookups such as listing documents or finding them by author, date, or reference. Anything you do not enable, including creating a new WeGA ID or reading application status, stays off limits to the agent.