{"id":587,"date":"2018-11-06T12:26:00","date_gmt":"2018-11-06T18:26:00","guid":{"rendered":"https:\/\/blog.felineflock.com\/?p=587"},"modified":"2024-01-01T12:27:47","modified_gmt":"2024-01-01T18:27:47","slug":"how-to-connect-to-salesforce-from-a-python-jupyter-notebook","status":"publish","type":"post","link":"https:\/\/blog.felineflock.com\/index.php\/2018\/11\/06\/how-to-connect-to-salesforce-from-a-python-jupyter-notebook\/","title":{"rendered":"How to Connect to Salesforce from a Python\/Jupyter Notebook"},"content":{"rendered":"\n

It might be useful to extract data from Salesforce directly into Python and manipulate the data as a Pandas dataframe.<\/p>\n\n\n\n

First, you need to create a Connected App in Salesforce and copy the consumer key and consumer secret.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Then start your Jupyter Notebook and create a Python notebook.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Start coding your Python notebook as follows:<\/p>\n\n\n\n

\n

import requests <\/p>\n\n\n\n

import json ## Authorization <\/p>\n\n\n\n

consumer_key = “enter the consumer key from your connected app here” <\/p>\n\n\n\n

consumer_secret = “enter the consumer secret from your connected app here” <\/p>\n\n\n\n

username = “enter your Salesforce username here” <\/p>\n\n\n\n

password = “enter your Salesforce password here”\u00a0 <\/p>\n\n\n\n

headers = { ‘Content-Type’: ‘application\/x-www-form-urlencoded’ } <\/p>\n\n\n\n

body = “grant_type=password&client_id=” + consumer_key \\<\/p>\n\n\n\n

\u00a0 \u00a0 + “&client_secret=” + consumer_secret + “&username=” \\<\/p>\n\n\n\n

\u00a0 \u00a0 + username + “&password=” + password <\/p>\n\n\n\n

url = “https:\/\/login.salesforce.com\/services\/oauth2\/token” <\/p>\n\n\n\n

resp = requests.post( url, headers= headers, data= body ) <\/p>\n\n\n\n

print( ‘Status: ‘ + str( resp.status_code ) ) <\/p>\n\n\n\n

print( json.dumps( resp.json(), indent= 4 ) ) <\/p>\n\n\n\n

print( resp.json()[ “access_token” ] )<\/p>\n<\/blockquote>\n\n\n\n

When executing, you should get results like below:<\/p>\n\n\n\n

\n

Status: 200 <\/p>\n\n\n\n

{ <\/p>\n\n\n\n

“access_token”: “00D… really long string here …”, <\/p>\n\n\n\n

“instance_url”: “https:\/\/na35.salesforce.com”, <\/p>\n\n\n\n

“id”: “https:\/\/login.salesforce.com\/id\/00D …”, <\/p>\n\n\n\n

“token_type”: “Bearer”, <\/p>\n\n\n\n

“issued_at”: “1541562541782”, <\/p>\n\n\n\n

“signature”: “… encoded string …” <\/p>\n\n\n\n

} <\/p>\n\n\n\n

00D … really long string here …<\/p>\n<\/blockquote>\n\n\n\n

Continue adding the code below:<\/p>\n\n\n\n

\n

session_id = resp.json()[ “access_token” ] <\/p>\n\n\n\n

headers = { ‘Authorization’: ‘Bearer ‘ + session_id\u00a0 } <\/p>\n\n\n\n

instance_url = resp.json()[ “instance_url” ] <\/p>\n\n\n\n

query = ‘SELECT ID, Name, BillingCity FROM Account’ <\/p>\n\n\n\n

# using Bulk API 1.0 <\/p>\n\n\n\n

url = instance_url + ‘\/services\/data\/v36.0\/query?q=’ + query <\/p>\n\n\n\n

resp = requests.get( url, headers= headers ) <\/p>\n\n\n\n

jsonResponse = resp.json() <\/p>\n\n\n\n

print( ‘Status: ‘ + str( resp.status_code ) ) <\/p>\n\n\n\n

print( json.dumps( jsonResponse, indent= 4 ) )<\/p>\n<\/blockquote>\n\n\n\n

And the resulting execution should look like this:<\/p>\n\n\n\n

\n

Status: 200 <\/p>\n\n\n\n

{ “totalSize”: 12, <\/p>\n\n\n\n

“done”: true, <\/p>\n\n\n\n

“records”: [ { “attributes”: { <\/p>\n\n\n\n

“type”: “Account”, <\/p>\n\n\n\n

“url”: “\/services\/data\/v36.0\/sobjects\/Account\/001….” <\/p>\n\n\n\n

}, <\/p>\n\n\n\n

“Id”: “001….”, <\/p>\n\n\n\n

“Name”: “GenePoint”, <\/p>\n\n\n\n

“BillingCity”: “Mountain View” <\/p>\n\n\n\n

}, …………..<\/p>\n<\/blockquote>\n\n\n\n

If you want to you can work with the data in JSON as is:<\/p>\n\n\n\n

\n

# first record <\/p>\n\n\n\n

print( jsonResponse[ “records” ][ 0 ] ) <\/p>\n\n\n\n

# first record id <\/p>\n\n\n\n

print( jsonResponse[ “records” ][ 0 ][ “Id” ] )<\/p>\n<\/blockquote>\n\n\n\n

But you can convert the JSON data to a Panda dataframe, which is a lot more powerful:<\/p>\n\n\n\n

\n

import pandas as pd <\/p>\n\n\n\n

from pandas.io.json import json_normalize <\/p>\n\n\n\n

data \u200b= jsonResponse[ “records” ] <\/p>\n\n\n\n

df = pd.DataFrame.from_dict( json_normalize( data ), orient= ‘columns’ ) <\/p>\n\n\n\n

df<\/p>\n<\/blockquote>\n\n\n\n

And get a dataframe like this:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Alternatively, you can use a Python library like simple-salesforce: https:\/\/pypi.org\/project\/simple-salesforce\/<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"

It might be useful to extract data from Salesforce directly into Python and manipulate the data as a Pandas dataframe. First, you need to create a Connected App in Salesforce and copy the consumer key and consumer secret. Then start your Jupyter Notebook and create a Python notebook. Start coding your Python notebook as follows: […]<\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"_uf_show_specific_survey":0,"_uf_disable_surveys":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-587","post","type-post","status-publish","format-standard","hentry","category-blog"],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/blog.felineflock.com\/index.php\/wp-json\/wp\/v2\/posts\/587","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.felineflock.com\/index.php\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.felineflock.com\/index.php\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.felineflock.com\/index.php\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.felineflock.com\/index.php\/wp-json\/wp\/v2\/comments?post=587"}],"version-history":[{"count":1,"href":"https:\/\/blog.felineflock.com\/index.php\/wp-json\/wp\/v2\/posts\/587\/revisions"}],"predecessor-version":[{"id":591,"href":"https:\/\/blog.felineflock.com\/index.php\/wp-json\/wp\/v2\/posts\/587\/revisions\/591"}],"wp:attachment":[{"href":"https:\/\/blog.felineflock.com\/index.php\/wp-json\/wp\/v2\/media?parent=587"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.felineflock.com\/index.php\/wp-json\/wp\/v2\/categories?post=587"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.felineflock.com\/index.php\/wp-json\/wp\/v2\/tags?post=587"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}