Skip to content
This repository has been archived by the owner on Jan 19, 2024. It is now read-only.

Latest commit

 

History

History
100 lines (72 loc) · 5.35 KB

README.md

File metadata and controls

100 lines (72 loc) · 5.35 KB
Raw

Template Retail Salesforce Customer System API

License Agreement

Note that using this template is subject to the conditions of this License Agreement. Please review the terms of the license before downloading and using this template. In short, you are allowed to use the template for free with Mule ESB Enterprise Edition, CloudHub, or as a trial in Anypoint Studio.

Use Case

This API allows to create, update the customer contacts in Salesforce and obtain the customer contact from Salesforce by customerId.

POST/customers

This endpoint will trigger flow postContactFlow which creates the customer contact to the Salesforce.

GET/customers/{customerId}

This endpoint will trigger flow getContactFlow which obtains a customer contact to the Salesforce by customerId.

PUT/customers/{customerId}

This endpoint will trigger flow putContactFlow which updates the customer contact to the Salesforce by customerId.

Look at the included self-descriptive RAML definition and the corresponding flows to learn more about the flows.

Considerations

To make this Anypoint Template run, there are certain preconditions that must be considered. Failling to do so could lead to unexpected behavior of the template.

APIs security considerations

This System API is meant to be deployed to CloudHub and managed using the API Platform Manager.

Run it!

Simple steps to get Retail Salesforce Customer System API running. See below.

Running on premise

In this section we detail the way you should run your Anypoint Template on your computer.

Where to Download Anypoint Studio and Mule ESB

First thing to know if you are a newcomer to Mule is where to get the tools.

  • You can download Anypoint Studio from this Location
  • You can download Mule ESB from this Location

Importing an Anypoint Template into Studio

Anypoint Studio offers several ways to import a project into the workspace, for instance:

  • Anypoint Studio generated Deployable Archive (.zip)
  • Anypoint Studio Project from External Location
  • Maven-based Mule Project from pom.xml
  • Mule ESB Configuration XML from External Location

You can find a detailed description on how to do so in this Documentation Page.

Running on Studio

Once you have imported you Anypoint Template into Anypoint Studio you need to follow these steps to run it:

  • Locate the properties file mule-<env>.properties, in src/main/app/resources
  • Complete all the properties required as per the examples in the section Properties to be configured
  • Once that is done, right click on you Anypoint Template project folder
  • Hover you mouse over "Run as"
  • Click on "Mule Application"

Running on Mule ESB stand alone

Complete all properties in one of the property files, for example in mule.prod.properties and run your app with the corresponding environment variable to use it. To follow the example, this will be mule.env=prod.

Running on CloudHub

While creating your application on CloudHub (Or you can do it later as a next step), you need to go to "Manage Application" > "Properties" to set all environment variables detailed in Properties to be configured. Follow other steps defined here and once your app is all set and started, there is no need to do anything else.

Deploying your Anypoint Template on CloudHub

Anypoint Studio provides you with really easy way to deploy your Template directly to CloudHub, for the specific steps to do so please check this link

Properties to be configured (With examples)

In order to use this Mule Anypoint Template you need to configure properties (Credentials, configurations, etc.) either in properties file or in CloudHub as Environment Variables.

Detailed list with examples:

Application properties

  • https.port 8081
  • keystore.location keystore.jks
  • keystore.password pass123!
  • key.password pass123!
  • key.alias 1

Salesforce Connector configuration

  • sfdc.username example@example.com
  • sfdc.password examplepass1
  • sfdc.securityToken eXample1111111
  • sfdc.url https://login.salesforce.com/services/Soap/u/38.0