How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AEB Document Service Master Data API

REST API for the Document Service master data maintenance

AEB Document Service Master Data API is one of 67 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include DocumentService_MasterData. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a changelog, and a GitHub repository.

This API exposes 10 operations across 5 paths, and defines 27 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://rz3.aeb.de/demo1docs/rest.

10 operations 5 paths 27 schemas 3 DELETE4 GET3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://rz3.aeb.de/test2ici/rest
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

AEB Document Service Master Data API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-XNSG_WEB_TOKEN (SWAGGER_AUTH_KEY). It accepts HTTP basic authentication (BASIC_AUTH). By default, every request must be authenticated.

Paths & Operations 10

Across 5 paths, the API surfaces 10 operations — 3 DELETE, 4 GET, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

DocumentService_MasterData 10

REST API for the Document Service master data maintenance

GET
/DocumentService/docType/{identCode}
getDocType
getDocType 1 param → 200404
PUT
/DocumentService/docType/{identCode}
putDocType
putDocType 1 param body → 204423
DELETE
/DocumentService/docType/{identCode}
deleteDocType
deleteDocType 2 params → 204404423
GET
/DocumentService/docType
getDocTypes
getDocTypes → 200
GET
/DocumentService/referenceType/{identCode}
getReferenceObjectType
getDocumentReferenceObjectType 1 param → 200404
PUT
/DocumentService/referenceType/{identCode}
putReferenceObjectType
putDocumentReferenceObjectType 1 param body → 204400423
DELETE
/DocumentService/referenceType/{identCode}
deleteReferenceObjectType
deleteDocumentReferenceObjectType 1 param → 204400404423
GET
/DocumentService/referenceType
getReferenceObjectTypes
getDocumentReferenceObjectTypes 1 param → 200
PUT
/DocumentService/template/{fileName}
putDocumentTemplate
putDocumentTemplate 1 param body → 204400423
DELETE
/DocumentService/template/{fileName}
deleteDocumentTemplate
deleteDocumentTemplate 1 param → 204400404423

Schemas 27

The contract defines 27 schemas that model the data the API accepts and returns. The most detailed are PutDocTypeDataDTO (13 properties), PutDocumentTemplateDataDTO (13 properties), PutDocTypeTemplateDTO (10 properties), DocTypeDTO (7 properties). Each schema is shown below with its type and property counts.

DocumentTemplateSchemaDTO
object
Schema
2 properties
GetDocTypesResponseDTO
object
5 properties
DocumentTemplateLocalizedTextDTO
object
2 properties
DocumentTemplateDocumentationTextDTO
object
Localized documentation texts.
3 properties
DocumentTemplateArchiveFieldDTO
object
Archive fields.
2 properties
LocalizedIdentCodeDTO
object
2 properties
DocumentReferenceObjectTypeDTO
object
DTO class for a document reference object type for maintenance purposes.
3 properties 1 required
GetDocumentReferenceObjectTypeResponseDTO
object
Response with data of a document reference object type
6 properties
DocumentTemplateSchemaObjectTypeDTO
object
Object types included in the schema.
2 properties
DocumentReferenceObjectTypeTranslationDTO
object
Text translations for the document reference object type
2 properties 1 required
PutDocumentReferenceObjectTypeDataDTO
object
4 properties
DocTypeDTO
object
7 properties 1 required
GetDocumentReferenceObjectTypesResponseDTO
object
5 properties
DocumentTemplateSchemaFieldDTO
object
Object fields.
5 properties
DocTemplateInfoDTO
object
Additional info on the document template.
5 properties
DocumentTemplateDocumentationDTO
object
Additional template documentation.
2 properties
PutDocumentTemplateDataDTO
object
13 properties 1 required
ErrorDTO
object
4 properties
DocumentTemplateLocalizedTextsDTO
object
Localized texts (applicable in the template via the {{key}} notation).
2 properties
DocTypeTranslationDTO
object
Translations of the type for different languages.
2 properties 1 required
GetDocTypeResponseDTO
object
5 properties
PutDocTypeDataDTO
object
13 properties
DocumentTemplateExampleFileDTO
object
Accompanying data example files.
2 properties
DocumentTemplateSchemaFieldDocumentationDTO
object
Localizable documentation of the field.
2 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
PutDocTypeTemplateDTO
object
10 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aeb-documentservice-masterdata-api-openapi.yml Raw ↑

Other APIs AEB publishes across the network.

AEB AEB Delivery API
AEB Billing API
AEB Billing Scenario API
AEB BIS Audit BF Bean API
AEB BISBF Bean API
AEB BSM Carrier API
AEB BSM International Customs API
AEB BSM Sync API
AEB Carrier API
AEB Carrier Definition API
AEB Carrier Description API
AEB Carrier Event Service BF Bean API
Where this information came from

This is an independent, third-party profile of AEB Document Service Master Data API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.