How to call an external REST API to get data from API and passing the variables from REST API to apex method in Salesforce using Apex REST Post Methods | How to pass variables from REST API to Apex in Salesforce

1,493 views

Hey guys, today in this post we are going to learn about How to call an external REST API to get data from API and passing the variables from REST API to apex method and inserting a record into custom object in Salesforce using Apex REST Post Methods.

This example we are passing the variables from REST API to apex method and putting the value into custom object’s fields that is returns from API Using Apex REST post method.

To access the external REST API, First we need to Adding the Remote Site Settings

Download ebooks:- Click here to download E-Book "The most 20 popular articles of w3web.net"

Follow the Steps:-

Setup ➡ Remote Site Settings ➡ Remote Site Name ➡ Enter the URL for the remote site

Don’t forget to check out:- How to Integrate Amazon S3 into Salesforce Uses of Named Credentials, Click Here For More Information

Files we used in this post example

restApiPostMethodCmp.cmp	Lightning Component	It is used to get data from API and passing the variables from REST API to apex method in salesforce.
restApiPostMethodCmpController.js	JavaScript Controller File	It is hold Javascript calloutCtrl function.
restApiPostMethodCmpHelper.js	JavaScript Controller Helper File	It is hold Javascript Helper getResponse function to get data from API calling through apex class method.
restApiPostMethodCmpCtrl.apxc	Apex Class Controller	It is used to get data from API and passing the variables from REST API to apex method through Rest Apex class method.
Custom Object	Object Name:- Pan_Verification__c Object’s Fields Name:- API_Name__c, Application_Number__c, Success_Status__c, Process_Status__c, Pan_Number__c, DOB__c, User_Name__c

Final Output

Other related post that would you like to learn in Salesforce

Subscribe My Channel :- Tech W3web - YouTube

Find the below steps:-

Create Lightning Component

Step 1:- Create Lightning Component : restApiPostMethodCmp.cmp

From Developer Console >> File >> New >> Lightning Component

restApiPostMethodCmp.cmp [Lightning Component File]

<aura:component controller="restApiPostMethodCmpCtrl" implements="force:appHostable,flexipage:availableForAllPageTypes,flexipage:availableForRecordHome,force:hasRecordId,forceCommunity:availableForAllPageTypes,force:lightningQuickAction" access="global" >
    <aura:attribute name="response" type="Map"/>
    <aura:attribute name="panResponse" type="Pan_Verification__c"/>    
    <aura:attribute name="mySpinner" type="boolean" default="false"/>
    
    <div class="slds slds-p-around--medium">
        <div class="slds-section__title-action slds-p-around--small">
            <h2><strong>Uses of Apex REST Post Methods</strong></h2>
        </div>
        
        <div class="slds-grid slds-wrap">
            
            <div class="slds-col slds-size_4-of-12 slds-p-horizontal--small slds-m-bottom--small">                
                <div class="slds-form-element">
                    <label class="slds-form-element__label">Name</label>
                    <div class="slds-form-element__controller">
                        <ui:inputText class="slds-input" aura:id="userName"/>
                    </div>
                </div>
            </div>
            
            <div class="slds-col slds-size_4-of-12 slds-p-horizontal--small slds-m-bottom--small">
                <div class="slds-form-element">                     
                    <div class="slds-form-element__controller">         
                        <lightning:input type="date" name="userDateBirth" label="Date Of Birth" aura:id="userDateBirth"/>                         
                    </div>
                </div>
            </div>
            
            <div class="slds-col slds-size_4-of-12 slds-p-horizontal--small slds-m-bottom--small">
                <div class="slds-form-element">
                    <label class="slds-form-element__label">Pan Number</label>
                    <div class="slds-form-element__controller">
                        <ui:inputText class="slds-input" aura:id="panNumber"/>
                    </div>
                </div>
            </div>
            
        </div>
        <div class="slds-text-align--center slds-m-top--medium slds-m-bottom--medium slds-p-horizontal--small">                 
            <button class="slds-button slds-button--brand" onclick="{!c.calloutCtrl}">Submit</button>
        </div>
        
        <br/><br/><br/>
        
        <table class="slds-table slds-table_bordered slds-table_col-bordered mystles" style="border:1px #ddd solid;">
            <thead>
                <th>API Name</th>
                <th>Application Number</th>
                <th>Success Status</th>
                <th>Process Status</th>
                <th>Pan Number</th>
                <th>Name</th>
                <th>Date of birth</th>
            </thead>
            <tbody>
                <tr> 
                    <td>{!v.panResponse.API_Name__c}</td>
                    <td>{!v.panResponse.Application_Number__c}</td>
                    <td>{!v.panResponse.Success_Status__c}</td>
                    <td>{!v.panResponse.Process_Status__c}</td>
                    <td>{!v.panResponse.Pan_Number__c}</td>
                    <td>{!v.panResponse.User_Name__c}</td>
                    <td>{!v.panResponse.DOB__c}</td>
                </tr>    
            </tbody>
        </table>
        
        <aura:if isTrue="{!v.mySpinner}">
            <section class="slds-modal slds-fade-in-open" aura:id="modalFade">
                <div class="slds-spinner_container">
                    <div role="status" class="slds-spinner slds-spinner_medium slds-spinner_brand">
                        <span class="slds-assistive-text">Loading</span>
                        <div class="slds-spinner__dot-a"></div>
                        <div class="slds-spinner__dot-b"></div>
                    </div>
                </div>
            </section>
            <div class="slds-backdrop slds-backdrop_open"></div>
        </aura:if>
        
<br/><br/>
   
<div style="border:1px #ddd solid; padding:10px; background:#eee; margin:40px 0;">
            
            <p data-aura-rendered-by="435:0"><img src="https://www.w3web.net/wp-content/uploads/2021/05/thumbsUpLike.png" width="25" height="25" style="vertical-align:top; margin-right:10px;" data-aura-rendered-by="436:0"><strong data-aura-rendered-by="437:0"><span style="font-size:16px; font-style:italic; display:inline-block; margin-right:5px;">Don't forget to check out:-</span><a href="https://www.w3web.net/" target="_blank" rel="noopener noreferrer" style="text-decoration:none;" data-aura-rendered-by="440:0">An easy way to learn step-by-step online free Salesforce tutorial, To know more Click  <span style="color:#ff8000; font-size:18px;" data-aura-rendered-by="442:0">Here..</span></a></strong></p>
 
            <br/><br/>
            <p data-aura-rendered-by="435:0"><img src="https://www.w3web.net/wp-content/uploads/2021/07/tickMarkIcon.png" width="25" height="25" style="vertical-align:top; margin-right:10px;" data-aura-rendered-by="436:0"><strong data-aura-rendered-by="437:0"><span style="font-size:17px; font-style:italic; display:inline-block; margin-right:5px; color:rgb(255 128 0);">You May Also Like →</span> </strong></p>
            <div style="display:block; overflow:hidden;"> 
                <div style="width: 50%; float:left; display:inline-block">
                    <ul style="list-style-type: square; font-size: 16px; margin: 0 0 0 54px; padding: 0;"> 
                        <li><a href="https://www.w3web.net/lwc-get-set-lightning-checkbox-value/" target="_blank" rel="noopener noreferrer">How to get selected checkbox value in lwc</a></li>
                        <li><a href="https://www.w3web.net/display-account-related-contacts-in-lwc/" target="_blank" rel="noopener noreferrer">how to display account related contacts based on AccountId in lwc</a></li>
                        <li><a href="https://www.w3web.net/create-lightning-datatable-row-actions-in-lwc/" target="_blank" rel="noopener noreferrer">how to create lightning datatable row actions in lwc</a></li>
                        <li><a href="https://www.w3web.net/if-and-else-condition-in-lwc/" target="_blank" rel="noopener noreferrer">how to use if and else condition in lwc</a></li>
                        <li><a href="https://www.w3web.net/get-selected-radio-button-value-and-checked-default-in-lwc/" target="_blank" rel="noopener noreferrer">how to display selected radio button value in lwc</a></li>
                    </ul>
            </div>
 
            <div style="width: 50%; float:left; display:inline-block">
                    <ul style="list-style-type: square; font-size: 16px; margin: 0 0 0 54px; padding: 0;"> 
                        <li><a href="https://www.w3web.net/display-account-related-contacts-lwc/" target="_blank" rel="noopener noreferrer">display account related contacts based on account name in lwc</a></li>
                        <li><a href="https://www.w3web.net/create-lightning-datatable-row-actions-in-lwc/" target="_blank" rel="noopener noreferrer">how to insert a record of account Using apex class in LWC</a></li>
                        <li><a href="https://www.w3web.net/fetch-picklist-values-dynamic-in-lwc/" target="_blank" rel="noopener noreferrer">how to get picklist values dynamically in lwc</a></li>
                        <li><a href="https://www.w3web.net/edit-save-and-remove-rows-dynamically-in-lightning-component/" target="_blank" rel="noopener noreferrer">how to edit/save row dynamically in lightning component</a></li>
                        <li><a href="https://www.w3web.net/update-parent-object-from-child/" target="_blank" rel="noopener noreferrer">update parent field from child using apex trigger</a></li>
                    </ul>
                </div>
               <div style="clear:both;"></div> 
               <br/>
                <div class="youtubeIcon">
                    <a href="https://www.youtube.com/channel/UCW62gTen2zniILj9xE6LmOg" target="_blank" rel="noopener noreferrer"><img src="https://www.w3web.net/wp-content/uploads/2021/11/youtubeIcon.png" width="25" height="25" style="vertical-align:top; margin-right:10px;"/> <strong>TechW3web:-</strong> To know more, Use this <span style="color: #ff8000; font-weight: bold;">Link</span> </a>
                </div>
    </div>
 
</div>

</div>
</aura:component>

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

<aura:attribute name="response" type="Map"/>

<aura:attribute name="panResponse" type="Pan_Verification__c"/>

<aura:attribute name="mySpinner" type="boolean" default="false"/>

<h2><strong>Uses of Apex REST Post Methods</strong></h2>

</div>

<ui:inputText class="slds-input" aura:id="userName"/>

</div>

<lightning:input type="date" name="userDateBirth" label="Date Of Birth" aura:id="userDateBirth"/>

</div>

<label class="slds-form-element__label">Pan Number</label>

<ui:inputText class="slds-input" aura:id="panNumber"/>

</div>

<button class="slds-button slds-button--brand" onclick="{!c.calloutCtrl}">Submit</button>

</div>

<thead>

<th>Application Number</th>

<th>Success Status</th>

<th>Process Status</th>

<th>Pan Number</th>

<th>Date of birth</th>

</thead>

<tbody>

<tr>

<td>{!v.panResponse.API_Name__c}</td>

<td>{!v.panResponse.Application_Number__c}</td>

<td>{!v.panResponse.Success_Status__c}</td>

<td>{!v.panResponse.Process_Status__c}</td>

<td>{!v.panResponse.Pan_Number__c}</td>

<td>{!v.panResponse.User_Name__c}</td>

<td>{!v.panResponse.DOB__c}</td>

</tr>

</tbody>

</table>

<aura:if isTrue="{!v.mySpinner}">

<span class="slds-assistive-text">Loading</span>

</div>

</section>

</aura:if>

<p data-aura-rendered-by="435:0"><img src="https://www.w3web.net/wp-content/uploads/2021/05/thumbsUpLike.png" width="25" height="25" style="vertical-align:top; margin-right:10px;" data-aura-rendered-by="436:0"><strong data-aura-rendered-by="437:0"><span style="font-size:16px; font-style:italic; display:inline-block; margin-right:5px;">Don't forget to check out:-</span><a href="https://www.w3web.net/" target="_blank" rel="noopener noreferrer" style="text-decoration:none;" data-aura-rendered-by="440:0">An easy way to learn step-by-step online free Salesforce tutorial, To know more Click <span style="color:#ff8000; font-size:18px;" data-aura-rendered-by="442:0">Here..</span></a></strong></p>

<li><a href="https://www.w3web.net/lwc-get-set-lightning-checkbox-value/" target="_blank" rel="noopener noreferrer">How to get selected checkbox value in lwc</a></li>

<li><a href="https://www.w3web.net/display-account-related-contacts-in-lwc/" target="_blank" rel="noopener noreferrer">how to display account related contacts based on AccountId in lwc</a></li>

<li><a href="https://www.w3web.net/create-lightning-datatable-row-actions-in-lwc/" target="_blank" rel="noopener noreferrer">how to create lightning datatable row actions in lwc</a></li>

<li><a href="https://www.w3web.net/if-and-else-condition-in-lwc/" target="_blank" rel="noopener noreferrer">how to use if and else condition in lwc</a></li>

<li><a href="https://www.w3web.net/get-selected-radio-button-value-and-checked-default-in-lwc/" target="_blank" rel="noopener noreferrer">how to display selected radio button value in lwc</a></li>

</ul>

</div>

<li><a href="https://www.w3web.net/display-account-related-contacts-lwc/" target="_blank" rel="noopener noreferrer">display account related contacts based on account name in lwc</a></li>

<li><a href="https://www.w3web.net/create-lightning-datatable-row-actions-in-lwc/" target="_blank" rel="noopener noreferrer">how to insert a record of account Using apex class in LWC</a></li>

<li><a href="https://www.w3web.net/fetch-picklist-values-dynamic-in-lwc/" target="_blank" rel="noopener noreferrer">how to get picklist values dynamically in lwc</a></li>

<li><a href="https://www.w3web.net/edit-save-and-remove-rows-dynamically-in-lightning-component/" target="_blank" rel="noopener noreferrer">how to edit/save row dynamically in lightning component</a></li>

<li><a href="https://www.w3web.net/update-parent-object-from-child/" target="_blank" rel="noopener noreferrer">update parent field from child using apex trigger</a></li>

</ul>

</div>

<br/>

<a href="https://www.youtube.com/channel/UCW62gTen2zniILj9xE6LmOg" target="_blank" rel="noopener noreferrer"><img src="https://www.w3web.net/wp-content/uploads/2021/11/youtubeIcon.png" width="25" height="25" style="vertical-align:top; margin-right:10px;"/> <strong>TechW3web:-</strong> To know more, Use this <span style="color: #ff8000; font-weight: bold;">Link</span> </a>

</div>

</div>

</aura:component>

Create Component JavaScript Controller

Step 2:- Create Lightning Component : restApiPostMethodCmpController.js

From Developer Console ➡ File ➡ New ➡ Lightning Component ➡ JavaScript Controller

restApiPostMethodCmpController.js [JavaScript Controller]

({

calloutCtrl : function(component, event, helper) {

helper.getResponse(component, event, helper);

})

Create Component JavaScript Helper

Step 4:- Create Lightning Component : restApiPostMethodCmpHelper.js

From Developer Console ➡ File ➡ New ➡ Lightning Component ➡ JavaScript Helper

restApiPostMethodCmpHelper.js [JavaScript Helper File]

({
	getResponse: function(component, event, helper) {             
        var action = component.get("c.getPanVerification");        
        var appNumberVal = "100";
        var userName = component.find('userName');
        var userNameVal = component.find('userName').get('v.value');
        var userDateBirth = component.find('userDateBirth');
        var userDateBirthVal = component.find('userDateBirth').get('v.value');
        var panNumber = component.find('panNumber');
        var panNumberVal = component.find('panNumber').get('v.value');
       // alert('userDateBirthVal ' + userDateBirthVal);
       
       
        action.setParams({          
            "url": 'http://test.com/api/restApiPostMethodRemote',
            "nameStr":userNameVal,
             "dobStr":userDateBirthVal,
             "panStr":panNumberVal
        });
        
        component.set("v.mySpinner",true);
     
        action.setCallback(this, function(response) {
            var state = response.getState();
            // alert('state_1 ' + state );
            if (state === "SUCCESS") { 
                component.set("v.mySpinner",false);                
                var results = response.getReturnValue();
                var getResponse = JSON.stringify(results);
                alert('AAAA' + JSON.stringify(results));
                 component.set("v.response", getResponse);    
                 component.set("v.panResponse", results);     
                 //var getAllValue = component.get("v.response")["apiName"];
                // console.log('getAllValue ' + getAllValue);
                 console.log('getResponse ' + getResponse);                
                 
            }
            else if(state === "ERROR"){
                component.set("v.mySpinner",false);
            }
        });
 
        $A.enqueueAction(action);
    },
    
    
    
})

({

getResponse: function(component, event, helper) {

var action = component.get("c.getPanVerification");

var appNumberVal = "100";

var userName = component.find('userName');

var userNameVal = component.find('userName').get('v.value');

var userDateBirth = component.find('userDateBirth');

var userDateBirthVal = component.find('userDateBirth').get('v.value');

var panNumber = component.find('panNumber');

var panNumberVal = component.find('panNumber').get('v.value');

// alert('userDateBirthVal ' + userDateBirthVal);

action.setParams({

"url": 'http://test.com/api/restApiPostMethodRemote',

"nameStr":userNameVal,

"dobStr":userDateBirthVal,

"panStr":panNumberVal

});

component.set("v.mySpinner",true);

action.setCallback(this, function(response) {

var state = response.getState();

// alert('state_1 ' + state );

if (state === "SUCCESS") {

component.set("v.mySpinner",false);

var results = response.getReturnValue();

var getResponse = JSON.stringify(results);

alert('AAAA' + JSON.stringify(results));

component.set("v.response", getResponse);

component.set("v.panResponse", results);

//var getAllValue = component.get("v.response")["apiName"];

// console.log('getAllValue ' + getAllValue);

console.log('getResponse ' + getResponse);

}

else if(state === "ERROR"){

component.set("v.mySpinner",false);

}

});

$A.enqueueAction(action);

})

Create Apex Class Controller

Step 5:- Create Apex Class : restApiPostMethodCmpCtrl.apxc

From Developer Console ➡ File ➡ New ➡ Apex Class

restApiPostMethodCmpCtrl.apxc [Apex Class Controller]

@RestResource(urlMapping='/restApiPostMethodRemote/') 
global with sharing class restApiPostMethodCmpCtrl {
  @AuraEnabled
	global static Pan_Verification__c getPanVerification(String url, String nameStr, String dobStr, String panStr) {
         Pan_Verification__c panObj = new Pan_Verification__c();
		// Instantiate a new http object
		Http h = new Http();
 
		// Instantiate a new HTTP request, specify the method (GET) as well as the endpoint
		HttpRequest req = new HttpRequest();
      
		req.setEndpoint(url);
        req.setTimeout(120000);
		req.setMethod('POST');
        req.setHeader('Content-Type', 'application/json;charset=UTF-8');     
        req.setHeader('Subscription-key', '12tcasAPI96Lpmakm');         
        
        req.setBody('{"callBackEndPoint" : null,"apiName": "pan-Verification","requestBody": {"applicantDetails": {"consent": "Y","dateOfBirth": "'+ dobStr +'","applicantName": "'+nameStr+'","panNumber": "'+ panStr +'"},"applicationDetails": {"applicationNumber": "100"}}}');
		// Send the request, and return a response
		HttpResponse res = h.send(req);
		System.debug('response:--> ' + res.getBody());
 
		// Deserialize the JSON string into collections of primitive data types.
		Map < String, Object > resultsMap = (Map < String, Object > ) JSON.deserializeUntyped(res.getBody());
        Map<String, Object>  resultsBody = (Map<String, Object>) resultsMap.get('responseBody');
        Map<String, Object>  resultsProData = (Map<String, Object>) resultsBody.get('processData');
        
		system.debug('resultsProData$$$$2 ' + resultsProData);
        string apiStr = String.valueof(resultsMap.get('apiName'));
        string applicationNumberStr = String.valueof(resultsMap.get('applicationNumber'));
        string successStr = String.valueof(resultsMap.get('success'));
        string processStatusStr = String.valueof(resultsBody.get('processStatus'));
        string processDataPanStr = String.valueof(resultsProData.get('pan'));
        string processDataNameStr = String.valueof(resultsProData.get('name'));
        string processDataDobStr = String.valueof(resultsProData.get('dob'));
        panObj.API_Name__c = apiStr;
        panObj.Application_Number__c = applicationNumberStr;
        panObj.Success_Status__c = successStr;
        panObj.Process_Status__c = processStatusStr;
        panObj.Pan_Number__c = processDataPanStr;
        panObj.DOB__c = processDataDobStr;
        panObj.User_Name__c = processDataNameStr;
        insert panObj;
        system.debug('panObj#### ' + panObj);
		return panObj;
	}
    
     
}

@RestResource(urlMapping='/restApiPostMethodRemote/')

global with sharing class restApiPostMethodCmpCtrl {

@AuraEnabled

global static Pan_Verification__c getPanVerification(String url, String nameStr, String dobStr, String panStr) {

Pan_Verification__c panObj = new Pan_Verification__c();

// Instantiate a new http object

Http h = new Http();

// Instantiate a new HTTP request, specify the method (GET) as well as the endpoint

HttpRequest req = new HttpRequest();

req.setEndpoint(url);

req.setTimeout(120000);

req.setMethod('POST');

req.setHeader('Content-Type', 'application/json;charset=UTF-8');

req.setHeader('Subscription-key', '12tcasAPI96Lpmakm');

req.setBody('{"callBackEndPoint" : null,"apiName": "pan-Verification","requestBody": {"applicantDetails": {"consent": "Y","dateOfBirth": "'+ dobStr +'","applicantName": "'+nameStr+'","panNumber": "'+ panStr +'"},"applicationDetails": {"applicationNumber": "100"}}}');

// Send the request, and return a response

HttpResponse res = h.send(req);

System.debug('response:--> ' + res.getBody());

// Deserialize the JSON string into collections of primitive data types.

Map < String, Object > resultsMap = (Map < String, Object > ) JSON.deserializeUntyped(res.getBody());

Map<String, Object> resultsBody = (Map<String, Object>) resultsMap.get('responseBody');

Map<String, Object> resultsProData = (Map<String, Object>) resultsBody.get('processData');

system.debug('resultsProData$$$$2 ' + resultsProData);

string apiStr = String.valueof(resultsMap.get('apiName'));

string applicationNumberStr = String.valueof(resultsMap.get('applicationNumber'));

string successStr = String.valueof(resultsMap.get('success'));

string processStatusStr = String.valueof(resultsBody.get('processStatus'));

string processDataPanStr = String.valueof(resultsProData.get('pan'));

string processDataNameStr = String.valueof(resultsProData.get('name'));

string processDataDobStr = String.valueof(resultsProData.get('dob'));

panObj.API_Name__c = apiStr;

panObj.Application_Number__c = applicationNumberStr;

panObj.Success_Status__c = successStr;

panObj.Process_Status__c = processStatusStr;

panObj.Pan_Number__c = processDataPanStr;

panObj.DOB__c = processDataDobStr;

panObj.User_Name__c = processDataNameStr;

insert panObj;

system.debug('panObj#### ' + panObj);

return panObj;

}

Create Lightning Application

Step 1:- Create Lightning Application : restApiPostMethodApp.app

From Developer Console ➡ File ➡ New ➡ Lightning Application

restApiPostMethodApp.app [Component Application File]

<aura:application extends="force:slds">

<c:lwcResetForm/>

</aura:application>

TechW3web:- To know more, Use this Link

Further post that would you like to learn in Salesforce

The Sitemap to Find all Published Post of The Tutorial w3web.net Click Here For More Information

TechW3web:- To know more, Use this Link

FAQ (Frequently Asked Questions)

How do you call an API in Salesforce?

To call third-party APIs from your component's JavaScript code, add the API endpoint as a CSP Trusted Site. To call Salesforce APIs, make the API calls from your component's Apex controller. Use a named credential to authenticate to Salesforce.

How do you call an external service from Salesforce?

Connect your Salesforce org to an external API using zero lines of code. Use declarative tools and OpenAPI specifications to describe the external API functionality, and External Services creates invocable actions within Salesforce. Use the invocable actions to create a flow that interacts with the external API source.

Can we call API from trigger in Salesforce?

The trigger will make a REST API call to Salesforce and will insert/update the record in the 'Account' object in Salesforce.

Author of w3web.net

Hi, This is Vijay Kumar behind the admin and founder of w3web.net. I am a senior software developer and working in MNC company from more than 8 years. I am great fan of technology, configuration, customization & development. Apart of this, I love to write about Blogging in spare time, Working on Mobile & Web application development, Salesforce lightning, Salesforce LWC and Salesforce Integration development in full time. [Read full bio] | | The Sitemap where you can find all published post on w3web.net