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.6.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.6-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: salesforcerestapi-0.1.6.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.6.tar.gz
Algorithm Hash digest
SHA256 8f20eba4382a5a95cb9c27c0c810ac289ef138e27fb0ae143af6b8033f81f8f2
MD5 c91622b8a71be3aaf45dfa4956352591
BLAKE2b-256 60b5e3e6e746dabea8e4073f9c102b5a95208673deed0ee10e1e0ac7c178611c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for salesforcerestapi-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 cafe2b0364908bc111194351288e1c4dc44309a45582239a94c13c19ed1b2cd9
MD5 b772fcfd115852fee3e285d5d7501a13
BLAKE2b-256 40718e92ed3ee12244cd4c45be55d9cce4f37eadb9a42639dda6d6c305bcdf23

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