{"id":4709,"date":"2015-07-16T01:15:47","date_gmt":"2015-07-16T01:15:47","guid":{"rendered":"http:\/\/www.jitendrazaa.com\/blog\/?p=4709"},"modified":"2015-08-29T00:45:48","modified_gmt":"2015-08-29T00:45:48","slug":"using-curl-with-salesforce-rest-api","status":"publish","type":"post","link":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/using-curl-with-salesforce-rest-api\/","title":{"rendered":"using cURL with Salesforce Rest API"},"content":{"rendered":"

Workbench <\/a>is one of widely used tool in Salesforce when it comes to exploring REST API of Salesforce. However\u00a0I wanted to export REST API response\u00a0in Binary format and therefore used cURL. cURL <\/a>is open source command line library mostly used to test\u00a0http request. It can be downloaded from here<\/a>\u00a0and official documentation about how to use cURL can be referred\u00a0from here<\/a>.<\/p>\n

To use cURL with Salesforce REST API, we will need to use username – password flow of OAuth2<\/a>. To use OAuth2, we need to create connected App. You can check “Create Connected app” section of this post<\/a>. You can enter any URL for callback or if you have already created any connected app in past, then it can be used. After creating connected app, note “Consumer key” and “Consumer Secret” somewhere.<\/p>\n

create file “LoginInfo.txt” file which will have all required login information in URL encoded\u00a0format<\/p>\n

\r\ngrant_type=password& client_id= 3MVG9iTxZANhwsdsdsdsdspr0Lu3QNRNKk4c2FejzTys5Mlp43UeSHBuhWWgRjEUyV6xE7N0GostjR3sRat & client_secret=21961212323233121943 & username=jitendra.zaa@demo.com & password=myPWDAndSecurityToken\r\n<\/pre>\n
make sure there is no space in above file. I have added some space for sake of readability.<\/p>\n
grant_type=password informs Salesforce to use “Username and password” flow of OAuth2, We are also passing client_id, client_secret, username and password.<\/p>\n
1. Login to Salsforce using cURL<\/strong><\/p>\n
Run below command to login into Salesforce<\/p>\n
\r\ncurl -X POST -d @LoginInfo.txt https:\/\/login.salesforce.com\/services\/oauth2\/token\r\n<\/pre>\n
Output :<\/p>\n
\r\n{"id":"https:\/\/login.salesforce.com\/id\/00D90000000YnViEAK\/00590000000Gl5VAAS", "issued_at":"1437005678627", "token_type":"Bearer", "instance_url":"https:\/\/shivasoftdemo-dev-ed.my.salesforce.com", "signature":"RlUOj40dyd0bhSZPNIKqE7Jp7DpyXSKULEFaYolW\/3I=", "access_token":"00D90000000YnVi!ARIAQB0fu5fjPy_ JClQ7B343ffdfRcPv0toe7QcotaZu1aWJnVmN2enCLAeUKBQVcnSvR3JjDz20 2LfRpGTRzaCdsds6lUBnaQ"}\r\n<\/pre>\n
Above output returned in JSON format is not readable so we can add header “PrettyPrint” in REST API request to return formatted json response.<\/p>\n
2.\u00a0Login to Salsforce using cURL with PrettyPrint option<\/strong><\/p>\n
new request will look like :<\/p>\n
\r\ncurl -X POST -d @LoginInfo.txt https:\/\/login.salesforce.com\/services\/oauth2\/token -H "X-PrettyPrint:1"\r\n<\/pre>\n
Output :<\/p>\n
\r\n{\r\n  "id" : "https:\/\/login.salesforce.com\/id\/00D90000000YnViEAK\/005900df000Gl5VAAS",\r\n  "issued_at" : "1437005809464",\r\n  "token_type" : "Bearer",\r\n  "instance_url" : "https:\/\/shivasoftdemo-dev-ed.my.salesforce.com",\r\n  "signature" : "3PD9nGTtpis23aWNP8IPtL3sYNuApFdfdd8eDa2Rc=",\r\n  "access_token" : "00D90000000YnVi!ARIAQB0fu5fjPy_JClQ7BrkkyX3RcPvdfdaWJnVmN 2enCLAeUKBQVcnSvR3JjDz202LfRpGTRzaCmsC6lUBnaQ"\r\n}\r\n<\/pre>\n
If login is success then we will get response as shown above. Extract “access_token” and “instance_url” from above response, as it will be used on every subsequent API calls.<\/p>\n
As we received session id in form of “access_token”, we can use cURL exactly like workbench as shown in below example.<\/p>\n
3. Example – Get information about all available REST API in Salesforce<\/strong><\/p>\n
\r\ncurl -H "Authorization: Bearer 00D90000000YnVi!ARIAQBdfu5fjPy_JClQ7BrkkyX3RcPv0toe 7QcotaZu1aWJnVmN2enCLAeUKBQVcnSvR3JjDz202LfRpGTRzaCmsC6lUBnaQ" -H "X-PrettyPrint:1" https:\/\/shivasoftdemo-dev-ed.my.salesforce.com\/services\/data\/v34.0\/\r\n<\/pre>\n
Don’t forget to include Bearer attribute in double quotes as session id contains exclamation mark and it creates issue while sending request.<\/p>\n
Output :<\/p>\n
\r\n{\r\n  "limits" : "\/services\/data\/v34.0\/limits",\r\n  "sobjects" : "\/services\/data\/v34.0\/sobjects",\r\n  "support" : "\/services\/data\/v34.0\/support",\r\n  "connect" : "\/services\/data\/v34.0\/connect",\r\n  "query" : "\/services\/data\/v34.0\/query",\r\n  "theme" : "\/services\/data\/v34.0\/theme",\r\n  "queryAll" : "\/services\/data\/v34.0\/queryAll",\r\n  "nouns" : "\/services\/data\/v34.0\/nouns",\r\n  "knowledgeManagement" : "\/services\/data\/v34.0\/knowledgeManagement",\r\n  "tooling" : "\/services\/data\/v34.0\/tooling",\r\n  "chatter" : "\/services\/data\/v34.0\/chatter",\r\n  "analytics" : "\/services\/data\/v34.0\/analytics",\r\n  "recent" : "\/services\/data\/v34.0\/recent",\r\n  "composite" : "\/services\/data\/v34.0\/composite",\r\n  "process" : "\/services\/data\/v34.0\/process",\r\n  "licensing" : "\/services\/data\/v34.0\/licensing",\r\n  "identity" : "https:\/\/login.salesforce.com\/id\/00D90000000YnViEAK\/00590000000Gl5VAAS",\r\n  "flexiPage" : "\/services\/data\/v34.0\/flexiPage",\r\n  "search" : "\/services\/data\/v34.0\/search",\r\n  "quickActions" : "\/services\/data\/v34.0\/quickActions",\r\n  "wave" : "\/services\/data\/v34.0\/wave",\r\n  "appMenu" : "\/services\/data\/v34.0\/appMenu",\r\n  "compactLayouts" : "\/services\/data\/v34.0\/compactLayouts",\r\n  "actions" : "\/services\/data\/v34.0\/actions",\r\n  "tabs" : "\/services\/data\/v34.0\/tabs"\r\n}\r\n<\/pre>\n
\"Using<\/a>
Using cURL with Salesforce REST API<\/figcaption><\/figure>\n
Making Salesforce REST API request without SessionId<\/strong><\/p>\n
Curl works like browser, If we try to access REST API\u00a0directly from browser then we get below error<\/p>\n
\"Salesforce<\/a>
Salesforce REST API without SessionId<\/figcaption><\/figure>\n
If we try to do same with cURL then we will get same error:<\/p>\n
\"Salesforce<\/a>
Salesforce REST API without SessionId Using Curl<\/figcaption><\/figure>\n
Try to access Visualforce page using cURL<\/strong><\/p>\n
To access Visualforce page in Salesforce, first we need to login to Salesforce. Once logged in,\u00a0if we try to access Visualforce page even with valid session Id, we will not get proper output because of Salesforce security ,\u00a0it shows that it is checking for sfdc.app and navigator and tries to redirect to Login page. \u00a0It does not display expected output from Visualforce. It clearly seems that salesforce is using some sort of security to check valid request.<\/p>\n
\"Salesforce<\/a>
Salesforce visualforce security check using cURL<\/figcaption><\/figure>\n
 <\/p>\n
 <\/p>\n
In same way, if we are logged in to curl previously and then try to access Visualforce using post method then salesforce tries to display form element with request forwarded from cURL. It does not display expected output from Visualforce. We can clearly see that how secure is salesforce and there is no way to break it.<\/p>\n
\"Access<\/a>
Access Visualforce page using cURL<\/figcaption><\/figure>\n
 <\/p>\n
 <\/p>\n","protected":false},"excerpt":{"rendered":"
Workbench is one of widely used tool in Salesforce when it comes to exploring REST API of Salesforce. However\u00a0I wanted to export REST API response\u00a0in Binary format and therefore used cURL. cURL is open source command line library mostly used to test\u00a0http request. It can be downloaded from here\u00a0and official documentation about how to use […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"advanced_seo_description":"","jetpack_seo_html_title":"","jetpack_seo_noindex":false,"jetpack_post_was_ever_published":false,"_jetpack_newsletter_access":"","_jetpack_dont_email_post_to_subs":false,"_jetpack_newsletter_tier_id":0,"_jetpack_memberships_contains_paywalled_content":false,"jz_research_post":"","_jetpack_memberships_contains_paid_content":false,"footnotes":""},"categories":[9],"tags":[328,260,170],"class_list":["post-4709","post","type-post","status-publish","format-standard","hentry","category-salesforce","tag-curl","tag-oauth","tag-rest-api"],"jetpack_featured_media_url":"","jetpack_sharing_enabled":true,"jetpack-related-posts":[{"id":3951,"url":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/creating-salesforce-query-builder-in-node-js-and-angularjs-using-salesforce-rest-api-and-oauth2\/","url_meta":{"origin":4709,"position":0},"title":"Creating Salesforce Query Builder in Node.js and AngularJs using Salesforce REST API and OAuth2 with Heroku Button","author":"Jitendra","date":"August 18, 2014","format":false,"excerpt":"In this post, we will be creating a\u00a0Salesforce Query (SOQL) Builder.\u00a0It uses Google's Angularjs MVC Javascript library and REST API provided by Salesforce. For Authentication, it uses OAuth2. Node.js is used as a primary language and hosted on Heroku. If you want to directly deploy to your Heroku Account, You\u2026","rel":"","context":"In "HTML"","block_context":{"text":"HTML","link":"https:\/\/www.jitendrazaa.com\/blog\/category\/webtech\/web\/"},"img":{"alt_text":"SOQL Builder Using Node.js AngularJs Salesforce REST API on Heroku","src":"https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2014\/08\/SOQL-Builder-Using-Node.js-AngularJs-Salesforce-REST-API-on-Heroku-1024x504.png?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2014\/08\/SOQL-Builder-Using-Node.js-AngularJs-Salesforce-REST-API-on-Heroku-1024x504.png?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2014\/08\/SOQL-Builder-Using-Node.js-AngularJs-Salesforce-REST-API-on-Heroku-1024x504.png?resize=525%2C300&ssl=1 1.5x"},"classes":[]},{"id":4769,"url":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/event-monitoring-and-trailhead\/","url_meta":{"origin":4709,"position":1},"title":"Event Monitoring and Trailhead","author":"Jitendra","date":"August 25, 2015","format":false,"excerpt":"This is one of most awaited functionality provided by Salesforce platform recently. In many projects,\u00a0we were getting request from clients on different kind of \u00a0auditing reports like \"most used functionality by users, who is exporting reports, API call usage, link clicks\" etc. Event monitoring tool helps to provide many information\u2026","rel":"","context":"In "Salesforce"","block_context":{"text":"Salesforce","link":"https:\/\/www.jitendrazaa.com\/blog\/category\/salesforce\/"},"img":{"alt_text":"Login by User - Event monitoring","src":"https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2015\/08\/elf_num_logins_by_user.png?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2015\/08\/elf_num_logins_by_user.png?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2015\/08\/elf_num_logins_by_user.png?resize=525%2C300&ssl=1 1.5x, https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2015\/08\/elf_num_logins_by_user.png?resize=700%2C400&ssl=1 2x"},"classes":[]},{"id":6152,"url":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/call-salesforce-rest-api-from-apex\/","url_meta":{"origin":4709,"position":2},"title":"Call Salesforce REST API from Apex","author":"Jitendra","date":"February 27, 2014","format":false,"excerpt":"Use Apex to call Salesforce REST API with sample source code","rel":"","context":"In "Salesforce"","block_context":{"text":"Salesforce","link":"https:\/\/www.jitendrazaa.com\/blog\/category\/salesforce\/"},"img":{"alt_text":"","src":"","width":0,"height":0},"classes":[]},{"id":3762,"url":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/salesforce-rest-api-playground\/","url_meta":{"origin":4709,"position":3},"title":"Salesforce REST API Playground","author":"Jitendra Zaa","date":"February 25, 2014","format":false,"excerpt":"What is REST API ? In my words, Getting data from Other System or Same System using HTTP request is known as REST API. If you know, how website works, you know REST API. Before REST API, there was SOAP request which needed lots of configuration and very tightly coupled.\u2026","rel":"","context":"In "Salesforce"","block_context":{"text":"Salesforce","link":"https:\/\/www.jitendrazaa.com\/blog\/category\/salesforce\/"},"img":{"alt_text":"REST API playground in Salesforce","src":"https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2014\/02\/REST-API-playground-in-Salesforce-1024x362.png?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2014\/02\/REST-API-playground-in-Salesforce-1024x362.png?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2014\/02\/REST-API-playground-in-Salesforce-1024x362.png?resize=525%2C300&ssl=1 1.5x"},"classes":[]},{"id":2903,"url":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/salesforce-toolkit-for-php\/","url_meta":{"origin":4709,"position":4},"title":"Salesforce Toolkit for PHP","author":"Jitendra","date":"June 7, 2012","format":false,"excerpt":"Example of using PHP toolkit in Salesforce with Sample code","rel":"","context":"In "Force.com"","block_context":{"text":"Force.com","link":"https:\/\/www.jitendrazaa.com\/blog\/category\/salesforce\/force-com\/"},"img":{"alt_text":"force.com toolkit for PHP toolkit","src":"https:\/\/i0.wp.com\/jitendrazaa.com\/blog\/wp-content\/uploads\/2012\/06\/force.com-toolkit-for-PHP-toolkit.png?resize=350%2C200&ssl=1","width":350,"height":200,"srcset":"https:\/\/i0.wp.com\/jitendrazaa.com\/blog\/wp-content\/uploads\/2012\/06\/force.com-toolkit-for-PHP-toolkit.png?resize=350%2C200&ssl=1 1x, https:\/\/i0.wp.com\/jitendrazaa.com\/blog\/wp-content\/uploads\/2012\/06\/force.com-toolkit-for-PHP-toolkit.png?resize=525%2C300&ssl=1 1.5x"},"classes":[]},{"id":4532,"url":"https:\/\/www.jitendrazaa.com\/blog\/salesforce\/salesforce-to-salesforce-integration-using-named-credentials-in-just-5-lines-of-code\/","url_meta":{"origin":4709,"position":5},"title":"Salesforce to Salesforce integration using Named Credentials in 5 lines","author":"Jitendra","date":"May 29, 2015","format":false,"excerpt":"I have already written article to integrate Salesforce with other Salesforce instance around 3 years back. In last 3 years, Salesforce has changed a lot. This time I will integrate Salesforce with other Salesforce only only in 5 lines of code, can you believe it \u00a0:) ? Check my old\u2026","rel":"","context":"In "Salesforce"","block_context":{"text":"Salesforce","link":"https:\/\/www.jitendrazaa.com\/blog\/category\/salesforce\/"},"img":{"alt_text":"Authenticated Named Credential in Salesforce","src":"https:\/\/i0.wp.com\/www.jitendrazaa.com\/blog\/wp-content\/uploads\/2015\/05\/Authenticated-Named-Credential-in-Salesforce.png?resize=350%2C200&ssl=1","width":350,"height":200},"classes":[]}],"jetpack_likes_enabled":true,"_links":{"self":[{"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/posts\/4709","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/comments?post=4709"}],"version-history":[{"count":14,"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/posts\/4709\/revisions"}],"predecessor-version":[{"id":4787,"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/posts\/4709\/revisions\/4787"}],"wp:attachment":[{"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/media?parent=4709"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/categories?post=4709"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.jitendrazaa.com\/blog\/wp-json\/wp\/v2\/tags?post=4709"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}