BEES Micro Services - general information
Description
BEES microservices are built in Java Spring boot archetype, the platform uses mongodb to store data and Kafka or Rabbitmq as the tool to manage messages.
BEES has data and business microservices. For each entity, the following steps are performed:
Generic Relay: receives data from ERP Adapter in batches, returns status 202 accepted and send it to Kafka (The zone will call one generic endpoint for all entities)
ETL Consumer: reads message from Kafka, extract, validate, apply cleasing and transform the data respecting BEES structure and load to the Value Stream Relay.
Cleansing: Filter data to avoid duplication sent by the zone, avoiding waste of resources
Feedback Layer: Provide visibility of integrations status and errors.
Value Stream Relay: receives data from ETL Consumer in batches and send it to RabbitMQ.
Value Stream Consumer: reads message from RabbitMQ and send to API to be inserted or updated in database.
API: process data receive (POST/PUT/DELETE) and retrieves data (GET).
For more details in a specific entity check the document referenced to it. This document aims to show the generic workflow and functionality for the great majority of the micro services built in this platform.
Data Ingestion Context
Integration Overview
Architecture Overview
Request Header attributes
In the table below, you will find all the request headers used in a generic way by internal BEES services. Analyze which cases apply to your scenario. If you have any questions, contact your ZSM or Professional Services team (Marketplace).
Header Requirements for MLP
Below are the rules related to the necessary headers to ensure the MLP when sending messages through BEES Sync. These rules specify the details of message forwarding as well as the essential attributes that must be included in the headers to ensure proper and personalized delivery to the end recipients.
Entity Name: REWARDS-CHALLENGES-BY-ACCOUNTS
Rule Description Detail: BEES Sync will forward message to VS Team and MLP Team simultaneously. MLP will NOT forward the message to VS Team only BEES Sync.
Header name: x-mlp-opt-in
Header value: TRUE
Header name: x-mlp-personalize
Header value: FALSE/EMPTY
Entity Name: REWARDS-CHALLENGES
Rule Description Detail: BEES Sync will forward message to VS Team and MLP Team simultaneously. MLP will NOT forward the message to VS Team only BEES Sync.
Header name: x-mlp-opt-in
Header value: TRUE
Header name: x-mlp-personalize
Header value: FALSE/EMPTY
Entity Name: PROMOTIONS
Rule Description Detail: BEES Sync will forward message to VS Team and MLP Team simultaneously. MLP will NOT forward the message to VS Team only BEES Sync.:
Header name: x-mlp-opt-in
Header value: TRUE
Header name: x-mlp-personalize
Header value: FALSE/EMPTY
Entity Name: PROMOTIONS - México, Colombia, Peru, Equador, Brazil
Rule Description Detail: BEES Sync will receive message from two different sources ERP and MAZ-MLP where:
MAZ-MLP must send Header name: x-mlp-opt-in
Header value: TRUE
MLP should NOT forward message to VS side.
Entity Name: GROW-LOCAL-MISSION
Rule Description Detail: BEES Sync will forward message to VS Team and MLP Team simultaneously. MLP will NOT forward the message to VS Team only BEES Sync.
Header name: x-mlp-opt-in
Header value: TRUE
Header name: x-mlp-personalize
Header value: FALSE/EMPTY
Entity Name: DIGI_COMMS_PRIORITY
Rule Description Detail: BEES Sync will forward message to VS Team and MLP Team simultaneously. MLP will NOT forward the message to VS Team only BEES Sync.
Header name: x-mlp-opt-in
Header value: TRUE
Header name: x-mlp-personalize
Header value: FALSE/EMPTY
Entity Name: DATA_PORTFOLIO_MODEL
Rule Description Detail: BEES Sync will forward message only to MLP Team and MLP Team will forward the message to VS Team.
Header name: x-mlp-opt-in
Header value: TRUE
Header name: x-mlp-personalize
Header value: TRUE
Entity Name: DATA_RECOMMENDATION
Rule Description Detail: BEES Sync will forward message only to MLP Team and MLP Team will forward the message to VS Team.
Header name: x-mlp-opt-in
Header value: TRUE
Header name: x-mlp-personalize
Header value: TRUE
URLs from Generic-Relay
Global
dev: https://services-dev.bees-platform.dev/api/v1/data-ingestion-relay-service/v1
sit: https://services-sit.bees-platform.dev/api/v1/data-ingestion-relay-service/v1
uat: https://services-uat.bees-platform.dev/api/v1/data-ingestion-relay-service/v1
prod: https://services.bees-platform.com/api/v1/data-ingestion-relay-service/v1
Europe
uat: https://services.eu.uat.restricted.mybees-platform.dev/api/v1/data-ingestion-relay-service/v1
prod: https://services.eu.mybees-platform.com/api/v1/data-ingestion-relay-service/v1
DTC
IMPORTANT: Limits of request sizing for all entities
Regardless the robustness infrastructure the Bees platform has, it is necessary to limit the size of payload in 1 Mb per request, related to security and performance reasons. This number could be grater if the payload is compressed.