Order to Cash Opportunity System API | Salesforce Implementation Template

This template serves as a foundation for the API led connectivity approach of running an enterprise.

This template is a REST API implemented using APIkit and RAML definition. The basic GET and PUT operations are implemented for Opportunity object. The API uses JSON as an exchange format. Included are example requests and responses.

The sections that follow provide the endpoints for this template.

GET/opportunities/search
This endpoint will trigger flow searchOpportunitiesSubFlow which obtains a opportunity information by search parameters.

GET/opportunities/{id}
This endpoint will trigger flow getOpportunitySubFlow which obtains a opportunity information by opportunity id.

GET/opportunities/{id}/products
This endpoint will trigger flow getProductsSubFlow which obtains information about products of opportunity by id.

PUT/opportunities/{id}
This endpoint will trigger flow putOpportunitySubFlow which updates opportunity information by opportunity id.

PUT/opportunities/invoice
This endpoint will trigger flow putInvoiceNumberSubFlow which updates invoice number in opportunities by order number.

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.

Considerations

To make this Anypoint Template run, there are certain preconditions that must be considered. Failing to do so could lead to unexpected behaviour 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 Order2Cash Opportunity2sfdc 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 Project from File System
• Packaged mule application (.jar)

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:

• 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

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

• http.port 8081
• api.basePath /api
• console.basePath /console

####Customer system API

• sfdc.username username@mail.com
• sfdc.password password123
• sfdc.securityToken secURIty123tokEN123