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.5.tar.gz (5.2 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.5-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: salesforcerestapi-0.1.5.tar.gz
  • Upload date:
  • Size: 5.2 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.5.tar.gz
Algorithm Hash digest
SHA256 d98893dddf105dbd83c05fdbcafda7a3d7437fcec8f9db5623ce5415b5536c61
MD5 62b2f6997ff69e55e151ac5e5a213c71
BLAKE2b-256 a258bb2e65ad96655a798f4afd8eddd3dae1e77f0980da1dda479a3235bf2d53

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for salesforcerestapi-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 0181ad2b9ba686505c3f9c05c54a15b565e2d65f7622d32cfc74e356d45b4d7b
MD5 507b4aa3b270cb7127888e32a09a4350
BLAKE2b-256 df49e6e7e0b9067879ae271bf77dbcc20b00e3fc879bc9611769311da31f1910

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