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 BISBF Bean API

Business facade for handling BrokerInstructions.

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

Tagged areas include BISBFBean. 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 4 operations across 4 paths, and defines 17 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

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

4 operations 4 paths 17 schemas 1 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

AEB BISBF Bean 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 4

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

BISBFBean 4

Business facade for handling BrokerInstructions.

POST
/BISBFBean/acknowledgeGetCustomerBrokerInstructions
Acknowledge, that the result of calling {@link getCustomerBrokerInstructions(GetCustomerBrokerInstructionsRequestDTO)} was processed.
acknowledgeGetCustomerBrokerInstructions body → default
POST
/BISBFBean/addBrokerInstructionEvents
Adds events to broker instruction.
addBrokerInstructionEvents body → default
GET
/BISBFBean/bisBfDummyMethod
Dummy method for testing.
bisBfDummyMethod_1 1 param → default
POST
/BISBFBean/getCustomerBrokerInstructions
Gets broker instructions from customer.
getCustomerBrokerInstructions body → default

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are BrokerEventsEventDTO (13 properties), AddBrokerInstructionEventsRequestDTO (8 properties), GetCustomerBrokerInstructionsResponseDTO (8 properties), AcknowledgeGetCustomerBrokerInstructionsRequestDTO (5 properties). Each schema is shown below with its type and property counts.

BISAttachmentDTO
object
Data transfer object to hold attachment data.
4 properties
AmountOfMoneyDTO
object
An amount of money with a value and an currency ISO code.
2 properties
DateAndZoneDTO
object
Date and timezone.
2 properties
AddBrokerInstructionEventsResponseDTO
object
Result data for adding events to a broker instruction.
4 properties
BISAmountOfMoneyDTO
objectnull
DTO to hold data representing an amount.
3 properties
AcknowledgeGetCustomerBrokerInstructionsRequestDTO
object
Request parameter for IBISBFacknowledgeGetCustomerBrokerInstructions(AcknowledgeGetCustomerBrokerInstructionsRequestDTO)
5 properties
GetCustomerBrokerInstructionsResponseDTO
object
Result data for getting customer broker instructions.
8 properties
CustomsBrokerDeclarationReferenceDTO
object
Minimal reference DTO to identify a customs broker declaration.
3 properties
AcknowledgeGetCustomerBrokerInstructionsResponseDTO
object
Response (result) for IBISBFacknowledgeGetCustomerBrokerInstructions(AcknowledgeGetCustomerBrokerInstructionsRequestDTO).
4 properties
BrokerEventReferenceDTO
objectnull
DTO to hold a references value.
2 properties
GetCustomerBrokerInstructionsRequestDTO
object
Body data for getting customer broker instructions.
4 properties
QuantityDTO
objectnull
A quantity with a value and a quantity unit. Quantity units are encoded by using AEB unit codes mainly based on the International System of Unit (e.g. 'Gram' i…
3 properties
AddBrokerInstructionEventsRequestDTO
object
Body data for adding events to a broker instruction.
8 properties
BrokerEventsEventDTO
object
DTO to hold an event.
13 properties
BrokerInstructionEnvelopeDTO
object
DTO to hold the data of a broker instruction
4 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aeb-bisbfbean-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 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
AEB Carrier Setup API
Where this information came from

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