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 Material BF Bean API

API for maintaining and requesting classification master data.

AEB Material 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 MaterialBFBean. 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 11 operations across 7 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 4.0.

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

11 operations 7 paths 29 schemas 2 DELETE3 GET3 PATCH2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

AEB Material 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 11

Across 7 paths, the API surfaces 11 operations — 2 DELETE, 3 GET, 3 PATCH, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

MaterialBFBean 11

API for maintaining and requesting classification master data.

PUT
/MaterialBFBean/materials/partnerSystems
Adds a new partner system to the materials. If a partner system subscription exists, journal entries will be created for the partner system.
addPartnersystem 4 params body → default
DELETE
/MaterialBFBean/materials/partnerSystems
Removes a partner system from the materials.
deletePartnersystem 3 params body → default
GET
/MaterialBFBean/materials/{materialNumber}
Get the data for one material.
getMaterial 12 params → default
DELETE
/MaterialBFBean/materials/{materialNumber}
Initiates the deletion of a material if the caller is owner of the material. If this is not the case, the partnersystem with the caller's clientSystemId is removed from the material.
deleteMaterial 4 params → default
PATCH
/MaterialBFBean/materials/{materialNumber}
Update the data of one material.
updateMaterial 5 params body → default
GET
/MaterialBFBean/businessObjects/{type}/{id}
Gets the data of a material related business object.
getBusinessObject 5 params → default
GET
/MaterialBFBean/materials/{materialNumber}/classificationProfiles/{profileCode}
Returns classification values of a classification profile for the requested material.
getClassification 7 params → default
PATCH
/MaterialBFBean/materials/{materialNumber}/classificationProfiles/{profileCode}
Ensures, that the a classification for the requested material and profile exists.
requestClassification 10 params → default
POST
/MaterialBFBean/materials/classificationProfiles/{profileCode}
Returns classification values of a classification profile for the requested materials.
getClassificationForMaterials 6 params body → default
POST
/MaterialBFBean/materials
Get the data for multiple materials.
getMaterials 11 params body → default
PATCH
/MaterialBFBean/materials/{materialNumber}/attachmentFiles/{fileName}
Update an attachment file in the engine.
updateFileAttachment 6 params body → default

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are MaterialDataDTO (8 properties), CertificateDTO (8 properties), ClassificationValueDTO (6 properties), CertificateTypeDTO (6 properties). Each schema is shown below with its type and property counts.

RequestClassificationResultDTO
object
Response DTO for requestClassifications
5 properties
GetMaterialResultDTO
object
Response DTO for getMaterial
5 properties
GetBusinessObjectResponseDTO
object
Response DTO for IMaterialBFgetBusinessObject .
5 properties
DeletePartnersystemOfMaterialRepsonseDTO
object
Response DTO for IMaterialBFdeletePartnersystem .
4 properties
DeleteMaterialResponseDTO
object
Response DTO for deleteMaterial
4 properties
MaterialNumbersDTO
object
DTO to hold multiple material numbers.
1 property
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
UpdateFileAttachmentResultDTO
object
Response DTO for updateFileAttachment
4 properties
GetMaterialsResultDTO
object
Response DTO for getMaterials
5 properties
MaterialDetailsDTO
objectnull
The container for material specific details.
5 properties
CertificateDTO
objectnull
DTO holding the information about a certificate.
8 properties 2 required
CertificateTypeDTO
object
DTO holding information about the type of the certificate.
6 properties 2 required
GenericDataFieldDTO
object
A field of a generic data record.
3 properties
FileContentDTO
object
DTO to hold the content of a file as byte array.
1 property 1 required
MaterialDescriptionDTO
objectnull
DTO to hold data of the description of a material in a defined language.
2 properties 1 required
ClassificationValueDTO
objectnull
DTO holding data of a specific classification value.
6 properties 1 required
GetClassificationForMaterialsResultDTO
object
Response DTO for IMaterialBFgetClassificationForMaterials .
5 properties
CertificateDataDTO
object
DTO holding information about the certificate instance.
6 properties 1 required
AttachmentLinkDTO
objectnull
DTO holding information about an attachment.
2 properties
ClassificationDTO
objectnull
A DTO containing the profile code of a classification that has been requested, or is about to be requested
5 properties 1 required
FeatureDTO
objectnull
DTO holding information about a feature.
3 properties 2 required
AddPartnersystemToMaterialResponseDTO
object
Response DTO for IMaterialBFaddPartnersystem .
4 properties
GenericDataRecordDTO
object
A generic record of data. Each field is qualified by name and type and has a value.
2 properties
ClassificationValuesOfMaterialDTO
object
DTO to hold classification values of a material.
2 properties
MaterialDataDTO
object
DTO to hold data of a material.
8 properties
UpdateMaterialResultDTO
object
Response DTO for updateMaterial
4 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
GetClassificationResultDTO
object
Response DTO for IMaterialBFgetClassification .
5 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aeb-materialbfbean-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 Material 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.