RCG Customers Process API - Implementation Template
home
This API implementation template is a component of the MuleSoft Accelerator for Retail, which accelerate the implementation of essential integration use cases.
The solution includes pre-built APIs, connectors, and integration templates that help unlock business-critical data from external systems and guide you in adopting best practices synthesized from thousands of customer implementations. Use these assets as is or extend them to meet your company’s unique needs.
Overview
This integration template implements the RCG Customers Process API specification. It can be used to retrieve, create, and update Customers.
Getting started
|
The Getting Started with MuleSoft Accelerators guide provides general information on getting started with the accelerator components. This includes instructions on setting up your local workstation for configuring and deploying the applications. |
Once your workstation has been set up and the application template imported into Anypoint Studio, proceed with the Prerequisites section.
Prerequisites
This implementation template has the following dependencies:
- Anypoint MQ Destinations
- RCG MDM System API
- RCG Salesforce Customers System API
- RCG Salesforce Marketing System API
- RCG ERP Customers Process API
- RCG SAP S/4 HANA Customers System API
- RCG B2C Customers System API
- RCG OFBiz Customers System API
- RCG Salesforce CG Cloud System API
Please review the use cases described on the MuleSoft Accelerator for Retail and MuleSoft Accelerator for Consumer Goods solution pages for more information about dependencies on other APIs and services.
API dependencies
The following table lists all endpoints used by this API (assuming all syncronization targets are enabled).
| API name | Endpoint | Action |
|---|---|---|
| RCG MDM System API | get:/individuals | Search a individual party |
| RCG MDM System API | get:/customers | Search a customer party role |
| RCG MDM System API | get:/organizations | Search an organization party |
| RCG MDM System API | post:/individuals | Create a new individual party |
| RCG MDM System API | post:/customers | Create a new customer party role |
| RCG MDM System API | post:/organizations | Create a new organization party |
| RCG MDM System API | post:/parties/{partyId}/contactPoints | Create contact points for a party |
| RCG MDM System API | put:/parties/{partyId}/contactPoints | Update contact points for a party |
| RCG MDM System API | put:/parties/{partyId}/externalIds | Update external IDs for a party |
| RCG MDM System API | patch:/individuals/{individualId} | Update an existing individual party |
| RCG MDM System API | patch:/customers/{customerId} | Update an existing customer party role |
| RCG MDM System API | put:/partyRoles/{partyRoleId}/externalIds | Update external IDs for a party role |
| RCG MDM System API | patch:/organizations/{organizationId} | Update an existing organization party |
| RCG MDM System API | get:/individuals/{individualId} | Retrieve an existing individual party |
| RCG MDM System API | get:/customers/{customerId} | Retrieve an existing customer party role |
| RCG MDM System API | get:/organizations/{organizationId} | Retrieve an existing organization party |
| RCG MDM System API | get:/partyRoles/{partyRoleId}/externalIds | get external IDs for a party role |
| Accelerator Salesforce Customers System API | get:/customers | Search for an existing customer |
| Accelerator Salesforce Customers System API | post:/customers | Create a new customer |
| Accelerator Salesforce Customers System API | patch:/customers/{customerId} | Update an existing customer |
| Accelerator Salesforce Marketing System API | get:/subscribers | Search for an existing subscriber or individual party |
| Accelerator Salesforce Marketing System API | post:/subscribers | Create a new subscriber or individual party |
| Accelerator Salesforce Marketing System API | patch:/subscribers/{subscriberId} | Update an existing subscriber or individual party |
| Accelerator ERP Customers Process API | put:/customers | Create or update customers in ERP systems |
| RCG SAP S/4 HANA Customers System API | get:/customers | Search for an existing customer |
| RCG SAP S/4 HANA Customers System API | post:/customers | Create a new customer |
| RCG SAP S/4 HANA Customers System API | patch:/customers/{customerId} | Update an existing customer |
| Accelerator B2C Customers System API | get:/customers | Search for an existing customer |
| Accelerator B2C Customers System API | post:/customers | Create a new customer |
| Accelerator B2C Customers System API | patch:/customers/{customerId} | Update an existing customer |
| Accelerator OFBiz Customers System API | get:/customers | Search for an existing customer |
| Accelerator OFBiz Customers System API | post:/customers | Create a new customer |
| Accelerator OFBiz Customers System API | patch:/customers/{customerId} | Update an existing customer |
| RCG Salesforce Consumer Goods Cloud System API | post:/customers | Create a new customer |
Anypoint MQ destinations
In addition to the Anypoint MQ client application credentials, the following destinations must be created and made accessible to this API:
- rcg-customer-update-retail-queue
- rcg-customer-update-retail-dl-queue
- rcg-individual-update-retail-queue
- rcg-individual-update-retail-dl-queue
Deployment
Each Accelerator implementation template in Exchange includes Bash and Windows scripts for building and deploying the APIs to CloudHub. These scripts depend on repositories, global settings, deployment profiles, and associated properties configured in the Maven settings.xml file. In particular, make sure the common properties for your environment have been provided in the CloudHub-DEV profile (e.g., Anypoint Platform client ID and secret).
For additional details, please refer to the Application Deployment section of the Getting Started Guide.
Preparation
Ensure the Maven profile CloudHub-RCG-DEV has been properly configured in your settings.xml file. In particular, make sure the common properties for your environment have been provided (e.g., Anypoint Platform client ID and secret).
Required property overrides
Many templates can also be run from Anypoint Studio without having to customize the Run/Debug profiles. However, some templates make use of hidden deployment properties to protect sensitive information (e.g., passwords and secret keys). These properties must be supplied to the runtime by updating the configuration profile and adding them as VM arguments. At a minimum, the following properties must be customized to reflect the target deployment environment.
| Property Name | Description |
|---|---|
| api.autodiscoveryID | Required if using API Manager to secure this API |
| oms-system.host | oms-system HostName |
| oms-system.port | oms-system Port |
| oms-system.base-path-orders | oms-system Base path |
| oms-system.base-path-customers | oms-system Base path customers |
| anypoint-mq.server-url | Anypoint MQ URL where the message Exchange, Topics, queues have been created |
| anypoint-mq.client-id | Anypoint MQ Client Id to access messages from MQ |
| anypoint-mq.client-secret | Anypoint MQ Client Secret to access messages from MQ |
| mdm-sys.host | MDM System API HostName |
| mdm-sys.port | MDM System API Port |
| mdm-sys.base-path | MDM System API Base path |
| marketing-sys.host | Salesforce Marketing System API HostName |
| marketing-sys.port | Salesforce Marketing System API Port |
| marketing-sys.base-path | Salesforce Marketing System API Base path |
| salesforce-sys.host | Salesforce Customers System API HostName |
| salesforce-sys.port | Salesforce Customers System API Port |
| salesforce-sys.base-path | Salesforce Customers System API Base path |
| sap-sys.host | SAP ECC Customers System API HostName |
| sap-sys.port | SAP ECC Customers System API Port |
| sap-sys.base-path | SAP ECC Customers System API Base path |
| b2c-customer-sys.host | B2C Customers System API HostName |
| b2c-customer-sys.port | B2C Customers System API Port |
| b2c-customer-sys.base-path | B2C Customers System API Base path |
| customers-prc-api.http-client.client-id | Client Id provided for Customer Process API to interact with all System API's |
| customers-prc-api.http-client.client-secret | Client Secret provided for Customer Process API to interact with all System API's |
Additional resources
- The Data mappings describes how the request and response data structures are mapped between the API interfaces.
- Refer to the Accelerators documentation home for more information about the MuleSoft Accelerators.