Accelerator Salesforce Customers Experience API - Implementation Template

(0 reviews)

home

This API implementation template is a shared component of MuleSoft Accelerators, 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 Accelerator Salesforce Customers Experience API specification. It supports the following functionalities:

  • Retrieve external identifiers for Customers
  • Retrieve external identifiers for Contacts
  • Lookup Customers

Getting started

bulb.png 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:

API dependencies

The following table lists all endpoints used by this API.

API nameEndpointAction
Global Party System APIget:/parties/{contactId}/externalIdsGet External IDs using contactId
Global Party System APIget:/partyRoles/{customerId}/externalIdsGet External IDs using customerId
Global Party System APIget:/customersLookup Customers

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-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

At a minimum, the following properties must be customized to reflect the target deployment environment.

Property NameDescription
api.autodiscoveryIDRequired if using API Manager to secure this API
global-party-sys-api.hostGlobal Party System API HostName
global-party-sys-api.portGlobal Party System API Port
global-party-sys-api.pingPathGlobal Party System API Ping path

Additional resources


Reviews

TypeTemplate
OrganizationMuleSoft
Published by
MuleSoft Solutions
Published onAug 31, 2023
Asset overview

Asset versions for 3.0.x

Asset versions
VersionActions
3.0.7
3.0.6
3.0.5