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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
AEB

AEB Foundation BF Bean API

REST endpoint for FoundationBF

Documentation Provider Profile APIs.io OpenAPI GitHub

AEB Foundation BF 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 FoundationBFBean. 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 31 operations across 30 paths, and defines 51 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 9 base URLs: https://rz3.aeb.de/test2bsm/rest, https://rz3.aeb.de/demo1cai/rest, https://xnsg.dc.aeb.com/demo1ces/rest, https://rz3.aeb.de/test2broker/rest, https://rz3.aeb.de/test2cim/rest, https://rz3.aeb.de/test2ici/rest, https://rz3.aeb.de/demo1docs/rest, https://rz3.aeb.de/test2cl/rest, https://rz3.aeb.de/test4ce/rest.

31 operations 30 paths 51 schemas 13 GET18 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 Foundation BF 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 31

Across 30 paths, the API surfaces 31 operations — 13 GET, 18 POST. Each is listed below with its method, path, parameters, and response codes.

FoundationBFBean 31

REST endpoint for FoundationBF

POST
/FoundationBFBean/acknowledgeFile
Acknowledges a file download.
acknowledgeFile body → 200
POST
/FoundationBFBean/announceStop
Announces a stop of the installation.
announceStop body → 200
POST
/FoundationBFBean/cancelAnnounceStop
Revokes an already announced stop.
cancelAnnounceStop body → 200
POST
/FoundationBFBean/changeAdminPassword
Changes the admin password.
changeAdminPassword body → 200
GET
/FoundationBFBean/client
Requests all clients from this engine, or one client identified by values in query parameter
queryClients 2 params → 200
POST
/FoundationBFBean/client
Create a client.
createClient body → 200
POST
/FoundationBFBean/downloadFile
Retrieves a file for download.
downloadFile body → 200
POST
/FoundationBFBean/generateClientIdentCode
Generates a client ident code.
generateClientIdentCode body → 200
GET
/FoundationBFBean/client/active
Requests all active clients from this engine.
getAllActiveClients → 200
GET
/FoundationBFBean/monitoringValue
Requests all monitoring values from this engine.
getAllMonitoringValues_1 → 200
GET
/FoundationBFBean/solution/{name}/build
Requests the build info for a solution from this engine.
getBuildForSolution_1 1 param → 200
POST
/FoundationBFBean/downloadableFileRefs
Retrieves refs for download.
getDownloadableFilesRefs body → 200
GET
/FoundationBFBean/monitoringValue/{groupName}/{valueName}
Requests a specific monitoring value from this engine.
getMonitoringValue_1 2 params → 200
GET
/FoundationBFBean/numberOfClients
Returns the number of clients.
getNumberOfClients → 200
GET
/FoundationBFBean/productInfo
Requests the product info from this engine.
getProductInfo_1 → 200
GET
/FoundationBFBean/runtimeInfo
Requests the runtime info from this engine.
getRuntimeInfo_1 → 200
POST
/FoundationBFBean/scriptExecutionState
gets a script execution state
getScriptExecutionState body → 200
POST
/FoundationBFBean/tableUpdateState
Retrieve the status of the table update.
getTableUpdateState body → 200
POST
/FoundationBFBean/uploadSettings
Retrieves the upload settings.
getUploadSettings body → 200
GET
/FoundationBFBean/solution/{name}/version
Requests the version info for a solution from this engine.
getVersionForSolution_1 1 param → 200
GET
/FoundationBFBean/workplaceURL
Requests the workplace url from this engine.
getWorkplaceURL → 200
GET
/FoundationBFBean/checkDebtorNumber
Checks if debtor number is known.
isDebtorNumberKnown 1 param → 200
POST
/FoundationBFBean/publishUserMessage
creates a user message, in several languages if required
publishUserMessage body → 200
GET
/FoundationBFBean/roles
Requests the current engine to report all its roles
requestReport → 200
GET
/FoundationBFBean/roles/{clientIdentCode}
Requests the current engine to report all roles for a specific client
requestReport_1 1 param → 200400404
POST
/FoundationBFBean/restartRFCServer
This method is only usefull to be called from SAP via RFC. It will restart the RFCServer which receives this method call. This method is useful to be called from SAP, if within SAP some structure def…
restartRFCServer_1 → default
POST
/FoundationBFBean/sendMail
Sends a mail.
sendMail body → 200
POST
/FoundationBFBean/startScriptExecution
Starts a script execution
startScriptExecution body → 200
POST
/FoundationBFBean/startTableUpdate
Starts the table update.
startTableUpdate body → 200
POST
/FoundationBFBean/systemSearch/{language}
Performs a system search in this engine.
systemSearch 1 param body → 200
POST
/FoundationBFBean/uploadFileMultiPart
Uploads a file using multipart.
uploadFileMultiPart body → 200

Schemas 51

The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are RuntimeInfoDTO (16 properties), PublishMessageRequestDTO (14 properties), DataHandler (10 properties), RoleInfoDTO (9 properties). Each schema is shown below with its type and property counts.

CancelAnnounceStopParmDTO
object
parameter necessary to cancel an announced stop
DataSource
object
4 properties
SendMailParmDTO
object
Parameter necessary for sending a mail
9 properties
UploadSettingsRequestDTO
object
retrieves the server settings for uploading files via SFT interface
2 properties
ScriptExecutionRowDTO
object
This dto contains the data of a single line in script result
2 properties
StartScriptExecutionResultDTO
object
result of start script execution
3 properties
TableUpdateStateResultDTO
object
Contains the result information of the get table update state bf
5 properties
AcknowledgeFileRequestDTO
object
Contains information about the result of a file transfer
3 properties
RoleInfoDTO
object
dto for roles
9 properties
MessageTextsDTO
object
locale specific data of the user tip. key is the language iso code.This language must be defined, or tip is not created.
7 properties
CommandInfo
object
2 properties
CancelAnnounceStopResultDTO
object
Contains the result information of the cancel announce stop bf
DLFilesRefsRequestDTO
object
Contains information on how to select files for transferring
3 properties
PublishMessageResponseDTO
object
Contains ids of user tips that were created, or error messages
1 property
SystemSearchParameterDTO
object
DTO used as argument to systemSearch function
3 properties
UploadFileMultiPartRequestDTO
object
Contains information on how a transmitted file should be processed
9 properties
PublishMessageRequestDTO
object
the for user tip, possibly in several locales
14 properties
ProductInfoDTO
object
This class holds various information items of the server which serves this request.
4 properties
ScriptExecutionStateParmDTO
object
parameters necessary to ask the server for the current state of the script execution
1 property
CommandMap
object
1 property
RuntimeInfoDTO
object
This class holds various runtime information items of the server which serves this request.
16 properties
VersionInfoDTO
object
This class holds version information about a solution or product in a server.
2 properties
MonitoringDataProviderDTO
object
Data Transfer Object for monitoring provider
3 properties
ClientDTO
object
DTO representing an XNSG Client.
6 properties
SendMailResultDTO
object
Contains the result of the sendMail method.
2 properties
FileDTO
object
Data Transfer Object for a file.
7 properties
ChangeAdminPasswordParmDTO
object
This class contains the old and the new admin password
2 properties
SystemSearchResultDTO
object
DTO contained in the result array of systemSearch function
7 properties
SendMailAttachmentParmDTO
object
Contains an attachment for an email.
3 properties
ActivationDataFlavor
object
2 properties
StartTableUpdateParmDTO
object
parameter necessary for the table update
ScriptExecutionStateResultDTO
object
Contains the result information of the script execution bf
4 properties
DownloadFileResponseDTO
object
Contains the result for a download file request
3 properties
DownloadFileRequestDTO
object
Contains information on how to select a file for transferring
4 properties
ChangeAdminPasswordResultDTO
object
Contains the result information of the change admin password bf
1 property
TableUpdateStateParmDTO
object
the parameter necessary to ask the server for the current state of the table update
DLFilesRefsResponseDTO
object
Contains the result for a request to get the number of files available for download
3 properties
UploadSettingsResponseDTO
object
retrieves the server settings for uploading files via SFT interface
3 properties
UploadFileResponseDTO
object
Contains the result for a upload file request.
2 properties
DataHandler
object
The content of a file
10 properties
AcknowledgeFileResponseDTO
object
Contains the result for an acknowledge file request.
2 properties
AnnounceStopParmDTO
object
parameter necessary to announce a stop of the server
3 properties
CreateClientResponseDTO
object
encapsulates the response parameters
1 property
GenerateClientIdentCodeRequestDTO
object
encapsulates the request parameters
2 properties
StartScriptExecutionParmDTO
object
parameters for start script execution
4 properties
SimpleFileDTO
object
Meta-data for a transfer file
2 properties
CreateClientRequestDTO
object
encapsulates the request parameters
3 properties
TransferFileParameterDTO
object
A generic parameter for use-case specific information
2 properties
AnnounceStopResultDTO
object
the result of the announce stop API
LinkDTO
object
links associated with the tip
3 properties
MessageDataDTO
object
resulting user tip for one locale
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aeb-foundationbfbean-api-openapi.yml Raw ↑

Other APIs AEB publishes across the network.

AEB AEB Delivery API
AE Profile APIs.io
AEB Billing API
AE Profile APIs.io
AEB Billing Scenario API
AE Profile APIs.io
AEB BIS Audit BF Bean API
AE Profile APIs.io
AEB BISBF Bean API
AE Profile APIs.io
AEB BSM Carrier API
AE Profile APIs.io
AEB BSM International Customs API
AE Profile APIs.io
AEB BSM Sync API
AE Profile APIs.io
AEB Carrier API
AE Profile APIs.io
AEB Carrier Definition API
AE Profile APIs.io
AEB Carrier Description API
AE Profile APIs.io
AEB Carrier Event Service BF Bean API
AE Profile APIs.io
#FoundationBFBean
← Back to A APIs
API Details
ID
aeb:aeb-foundationbfbean-api
Base URL
https://rz3.aeb.de/test2ici/rest
Docs
https://customsmanagement.docs.developers.aeb.com/
Provider
AEB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=aeb-foundationbfbean-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/aeb-foundationbfbean-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

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