FINS Salesforce Marketing System API - Implementation Template
home
This API implementation template is a 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 Salesforce Marketing System 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 assumes that you have appropriate roles in Salesforce Marketing Cloud System to create Installed Packages and Data Extensions. It has the following dependencies:
- Installed Package created for connectivity
- Data extensions created
- Pre-built customer journey flows
- Pre-built email templates
- Sample form for online submission of leads
Instructions to configure the above dependencies can be found in the Salesforce Marketing Cloud setup guide.
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.
For additional details, please refer to the Application Deployment section of the Getting Started Guide.
Preparation
Ensure the Maven profile CloudHub-FINS-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. An Installed Package is created on Salesforce Marketing System and details are available from the API Integration section of Installed Package Details screen.
| Property Name | Description |
|---|---|
api.autodiscoveryID | Required if using API Manager to secure this API |
sfdc-mc.subdomain | Salesforce Marketing System sub domain |
sfdc-mc.client-id | Salesforce Marketing System Installed Package Client Id for API Integration |
sfdc-mc.client-secret | Salesforce Marketing System Installed Package Client Secret for API Integration |
sfdc-mc.account-id | Salesforce Marketing System Account Id of the instance |
sfdc-mc.auth-url | Salesforce Marketing System Auth URL of Installed Package for API Integration |
sfdc-mc.soap-url | Salesforce Marketing System SOAP URL of Installed Package for API Integration |
Testing
Use Advanced Rest Client or Postman to send a request over HTTPS. The template includes a Postman collection in the src/test/resources folder. Update the collection variable(s) after successful import.
Additional resources
- The Data mappings tab 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.