Salesforce Rest API using cURL

-

cURL installation and setup guide

  • First, download the cURL from the site, https://curl.haxx.se/download.html
  • Select the OS version and download the file accordingly. For example, I have downloaded the 64 bit version for my windows 10, as mentioned in the below screenshot.

  • Once after downloading the same, unzip the same and look for the folder where the “exe” file and a “certificate” resides.
  • For example, in my machine, the two files located in the path as mentioned in below screenshots,

 

  • Then please note down the complete path where both resides and we need to set the path to our System. For example, the complete path in my machine would look like this,
C:\Users\ryanamala\Downloads\curl-7.64.0_2-win64-mingw\curl-7.64.0-win64-mingw\bin
  • Now, got to this path Control Panel→ System and Security→ System→ Advanced System Settings → A pop up window opens.
  • Please select the Environment Variables button, Then we need to add the complete path which we copied earlier and add the same to the Variable named PATH.
  • Look for PATH variable in both User variables and System Variables and edit the path variable to add a new location.
  • Go to System Variables → Look for Path → Click Edit button → now a new popup window opens up → Click on New → Then an inline-editor opens → There we need to copy the complete path that we copied earlier.
  • Follow the same process for the User Variables section as well.
  • Please find the screenshot for your reference,

 





  • Till now, we have configured the system variables and the path. Now, we can go to use the cURL from our machine.
  • You need to install the cURL software, since its a open source application, we can use directly from our command prompt.
  • Now look for the downloaded folder where the certificate is located. Then try to install the certificate in your machine.

  1. Locate the certificate first.  



  1. Then, Right click on it and hit install this certificate.
  2. Select to install the certificate for local machine. Please find the screenshot for the same,





  1. Then click next → Hit yes for the “dll installation”.
  2. Then select the option “Automatically select the certificate store bases on the type of certificate”



  1. Click on Finish. That's it. The certificate got installed successfully.
  • Now, we can test the cURL from our machine using the command prompt.
  • Open the command prompt in your machine, and then type curl, then it will show the output as shown below


  • Then type the command as “curl —help”, you will find so many commands as mentioned below,


  • The cURL works like a web-browser. In order to test any URL, we can just append the curl in-front of that URL and hit enter.
Example:- curl www.google.com


 By this way, we can test any URL like if we test in any API.




Business Scenario


We have an endpoint URL in our Salesforce and it is not working properly. And all our integrations are failing due to the incorrect endpoint.


Solution:- 


  • We just need to copy the endpoint URL that got configured in our Salesforce org and need to test the same in the command prompt using the simple command as mentioned in the above screenshot.

For example, this is my endpoint  "https://callbackhunter.com/api/get_calls_data?id=1256&key=0f89bf53497f95f2f6556ea44e667007&date=2019-02-22>"

  • Then I need to copy this and just type curl -vv -I -L and then paste this URL and hit enter.

C:\Users\ryanamala>curl -vv -I -L "https://callbackhunter.com/api/get_calls_data?id=1256&key=0f89bf53497f95f2f6556ea44e667007&date=2019-02-22>"

  • Then we will get the response from that call as shown below,


> Host: callbackhunter.com
> User-Agent: curl/7.55.1
> Accept: / < HTTP/1.1 200 OK
HTTP/1.1 200 OK
< Server: nginx
Server: nginx
< Date: Fri, 15 Mar 2019 10:30:07 GMT
Date: Fri, 15 Mar 2019 10:30:07 GMT
< Content-Type: application/json; charset=utf-8
Content-Type: application/json; charset=utf-8
< Connection: keep-alive
 
The above response depicts that our connection is alive. So the endpoint URL that we have tested is working fine and it is responding to our ping.


Comments

Post a Comment

Popular posts from this blog

Apex Code Character Limit (Part I)

-
Image
Apex Code Character Limit What is Apex Code Character Limit? As we know, Salesforce works on a multi-tenant environment. So it provides common resources to every org. If we speak in terms of writing Apex code in our Org, due to multi-tenant architecture design, we do have a limit on code characters for every org.  That means, Salesforce literally counts each and every character that we use to write any code. This limit is called Apex Code Character Limit. The code character limit is almost the same for every org. As of now (after Summer'18 release), the code character limit would be 6 Million. This indicates that any developer can write and develop code in their org up to 6 Million characters. For suppose, if a developer has exhausted the provided code character limit, then an error would be thrown stating that " The total size of apex code in this application after removing comments exceeds the maximum character size of 6000000 ". So we cannot write
Read more

SFDX Developer Guide

-
Image
SFDX Developer Guide SFDX Developer Guide SFDX - Salesforce Developer Experience This doc explains the SFDX concepts in detail and it's solely based on my analysis and understanding. - Rajesh Babu Yanamala How to install SFDX on my machine? For Mac OS -  https://sfdc.co/sfdx_cli_osx For Windows 32-bit -  https://sfdc.co/sfdx_cli_win For Windows 64-bit -  https://sfdc.co/sfdx_cli_win64 Select the defaults, then install it in your machine. Once it's installed in our machine, then we need to verify whether it has been installed correctly. For that, we need to open the Command Prompt from our machine and type the command “ sfdx ” In order to check the version of the CLI, you can use the following command, sfdx --version -To see the installed plugins for SFDX CLI, then type this command, sfdx plugins To know the Salesforce version that's used in our CLI which you have installed, type this, sfdx force --version =
Read more

Deployment in Salesforce using Change sets

-
Image
Deployments in Salesforce Deployments in Salesforce Deployment is the migration of metadata changes between one Salesforce org to another Salesforce org. There are many tools available for Deployment in Salesforce. In this post, we will discuss about Changesets. To use the changesets feature, we need to enable the deployment connection in our org. This would specify the Inbound and Outbound changesets on the Deployment connections page. In Production org, Go to Setup → Type Deployment Settings → Then it will take us to the Deployment Settings page where, it will show the orgs that were connected to this Production org for deployment purpose. By the same way, if we check the Sandbox org “sfdemo1” also, we can be able to see the connected org for deployment as shown below, Sandbox org “sfdemo1” Now, we are going to deploy the things from Sandbox to Production. That means, we are developing the things in Sandbox and going to deploy the same in the Production org. So
Read more

Apex Code Character Limit (Part II)

-
Increase Apex Code Character Limit We all know about Salesforce Apex Code Character limit and how to check the limit that we exhausted in our org.  USE CASE :- For suppose, if I reached the maximum code character limit in my org and I would like to code further, but the system is not allowing me to do so. In this situation, can I reach out to Salesforce Support to get this limit increased for me? The answer is YES. But conditions apply. Increasing the Apex Code Character Limit is not an easy task for Salesforce support. We need to ensure that we followed all best practices and need to check for any anti-patterns, Invalid test practices and Invalid classes. After performing all these checks from our end, then we are good to raise a case with Salesforce to increase the code character limit for my org. Points to Note:- The Code character limit count includes the spaces, tabs and other formatting characters inside the code. The code comes with any managed package
Read more

Force.com ANT Migration tool

-
Image
Force.com Migration Tool (ANT) Guide Force.com  Migration Tool (ANT) Guide Here is the simple guide to setup the Force.com Migration tool (ANT). --> First step is to download the JAVA JDK and APACHE ANT in your machine. Install the latest version of Java JDK from here,  https://www.oracle.com/technetwork/java/javase/downloads/index.html Install the latest version of Apache ANT from here,  http://ant.apache.org/bindownload.cgi Step 1:- -> Now we go to setup the JAVA JDK in our machine. After installing the Java, it should get installed in our C drive Program Files folder. Please find the screenshot for the same, -> So, we need to observe the installed java version and 'bin' folder. Then we need to setup the environment variables in our machine, for that pl
Read more