Skip to main content

A simple library to interact with Salesforce REST API using OAuth 2.0 Client Credentials Flow.

Project description

SalesforceRESTAPI

A simple Python library to interact with the Salesforce REST API using OAuth 2.0 Client Credentials Flow.

Features

  • Authenticate with Salesforce using OAuth 2.0 Client Credentials
  • Basic CRUD operations (create, read, update, delete) for Salesforce objects
  • SOQL query support
  • Apex script execution via Tooling API
  • Record verification utilities

Installation

pip install SalesforceRESTAPI

Usage

Note: As of version 0.1.3, authentication state (instance_url, access_token, headers) is stored as class variables. You must call SalesforceRESTAPI.authenticate(...) before using any instance methods. All instances share the same authentication state.

from SalesforceRESTAPI import SalesforceRESTAPI

# Authenticate (call this once before using any instance methods)
SalesforceRESTAPI.authenticate(client_id='YOUR_CLIENT_ID', client_secret='YOUR_CLIENT_SECRET', login_url='https://login.salesforce.com')

# Now you can use instance methods
sf = SalesforceRESTAPI()

# Create a record
account_id = sf.create_record('Account', Name='Test Account', Industry='Technology')

# Get a record
account = sf.get_record('Account', account_id)

# Update a record
sf.update_record('Account', account_id, Name='Updated Name')

# Delete a record
sf.delete_record('Account', account_id)

# Run a SOQL query
results = sf.queryRecords('SELECT Id, Name FROM Account')

# Execute anonymous Apex
apex_result = sf.execute_apex('System.debug("Hello World");')

# Revoke authentication (clears class-level state)
sf.revoke()

Requirements

  • Python 3.6+
  • requests
  • python-dotenv (for loading .env files in tests)

License

MIT License. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

salesforcerestapi-0.1.7.tar.gz (5.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

salesforcerestapi-0.1.7-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file salesforcerestapi-0.1.7.tar.gz.

File metadata

  • Download URL: salesforcerestapi-0.1.7.tar.gz
  • Upload date:
  • Size: 5.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for salesforcerestapi-0.1.7.tar.gz
Algorithm Hash digest
SHA256 4577bf1199b588ee552b49f9f0284230c93af762216dfb88f2eaed1a0f645332
MD5 513457f9da904be25006625eb2a7822c
BLAKE2b-256 f2f516034d6e7d9fe5ae5964293468c29130f7a02996c2e635716a2021d4c6d4

See more details on using hashes here.

File details

Details for the file salesforcerestapi-0.1.7-py3-none-any.whl.

File metadata

File hashes

Hashes for salesforcerestapi-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 73cdc3075536e73a67249d10fcf262f1d8e050bd362a62d2ca05f901ccf375d8
MD5 fd8dcf7df8b7ec904a40a6c1479ceecb
BLAKE2b-256 1b6039f2d2e4488fc624831e0dee1178f780b411f9788015024b597c9c1d7cd1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page