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 BSM Sync API

API for synchronizing data asynchronous from an engine to a client system

AEB BSM Sync API is one of 67 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include BSM Sync. 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 6 operations across 6 paths, and defines 18 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/test2bsm/rest.

6 operations 6 paths 18 schemas 6 POST

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 BSM Sync 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 6

Across 6 paths, the API surfaces 6 operations — 6 POST. Each is listed below with its method, path, parameters, and response codes.

BSM Sync 6

API for synchronizing data asynchronous from an engine to a client system

POST
/BSMSyncBFBean/acknowledgeEvents
acknowledgeEvents
acknowledgeEvents body → default
POST
/BSMSyncBFBean/getNotAcknowledgedEvents
getNotAcknowledgedEvents
getNotAcknowledgedEvents body → default
POST
/BSMSyncBFBean/getPartnerSystemSubscriptions
getPartnerSystemSubscriptions
getPartnerSystemSubscriptions body → default
POST
/BSMSyncBFBean/subscribePartnerSystem
subscribePartnerSystem
subscribePartnerSystem body → default
POST
/BSMSyncBFBean/synchronizeEvents
synchronizeEvents
synchronizeEvents body → default
POST
/BSMSyncBFBean/unsubscribePartnerSystem
unsubscribePartnerSystem
unsubscribePartnerSystem body → default

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are BSMSyncEventsRequestDTO (10 properties), SyncEventsResponseDTO (8 properties), BSMAcknowledgeEventsRequestDTO (7 properties), BSMSubscribePartnerSystemRequestDTO (7 properties). Each schema is shown below with its type and property counts.

AcknowledgeEventsResponseDTO
object
Response DTO for acknowledging events.
4 properties
BSMGetPartnerSystemSubscriptionsRequestDTO
object
Request parameter to fetch all or filtered partner system subscriptions to sync events.
6 properties
BSMSubscribePartnerSystemRequestDTO
object
Request parameter to subscribe a partner system to sync events.
7 properties 1 required
DateAndZoneDTO
object
Date and timezone.
2 properties
GetPartnerSystemSubscriptionsResponseDTO
object
Response parameter with fetched partner system subscriptions to sync events.
5 properties
SyncPartnerSystemDTO
object
Identification and other data of a single partner system subscription.
3 properties 2 required
SyncEventDTO
object
DTO to hold data of one synchronized event.
7 properties
GenericDataFieldDTO
object
A field of a generic data record.
3 properties
UnsubscribePartnerSystemResponseDTO
object
Response parameter of a partner system unsubscription from sync events.
5 properties
SubscribePartnerSystemResponseDTO
object
Response parameter of a partner system subscription to sync events.
5 properties
NamedGenericDataRecordDTO
object
A generic data record with a name. Wrapper class to encapsulate subrecords with their name and with the ability to have explicit null records.
2 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
BSMAcknowledgeEventsRequestDTO
object
Request DTO for acknowledging events.
7 properties
SyncEventsResponseDTO
object
Response DTO for synchronizing events.
8 properties
GenericDataRecordDTO
object
A generic record of data. Each field is qualified by name and type and has a value.
2 properties
BSMSyncEventsRequestDTO
object
Request DTO for synchronizing events.
10 properties
BSMUnsubscribePartnerSystemRequestDTO
object
Request parameter to unsubscribe a partner system from sync events.
6 properties 1 required
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aeb-bsm-sync-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 Carrier API
AEB Carrier Definition API
AEB Carrier Description API
AEB Carrier Event Service BF Bean API
AEB Carrier Setup API
Where this information came from

This is an independent, third-party profile of AEB BSM Sync 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.