salesforce_core

Unofficial Rust SDK for the Salesforce Core (Sales Cloud, Service Cloud, Platform) APIs: REST, Bulk 2.0, Pub/Sub (gRPC), and Tooling.

Part of the salesforce-rs project.

Installation

[dependencies]
salesforce_core = "0.13"

Cargo features

Each API surface is gated behind a feature so applications only pay the compile-time cost of what they use. All four are enabled by default.

For a slim build, disable defaults and opt in:

salesforce_core = { version = "0.13", default-features = false, features = ["restapi"] }

Quick start

Authenticate with the client credentials OAuth2 flow, then issue REST calls:

use salesforce_core::client;
use salesforce_core::restapi;
use serde_json::json;
use std::path::PathBuf;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let auth = client::Builder::new()
        .credentials_path(PathBuf::from(std::env::var("SFDC_CREDENTIALS")?))
        .build()?
        .connect()
        .await?;

    let rest = restapi::ClientBuilder::new(auth).build()?;

    let resp = rest.create("Account", json!({ "Name": "Acme" })).await?;
    let record = rest.get("Account", &resp.id, None).await?;
    println!("{record}");
    rest.delete("Account", &resp.id).await?;

    Ok(())
}

The credentials JSON file:

{
  "client_id": "...",
  "client_secret": "...",
  "instance_url": "https://your-instance.my.salesforce.com",
  "tenant_id": "..."
}

API coverage

Authentication

SObject REST API

Composite REST API

Search

Bulk API 2.0 — Query

Bulk API 2.0 — Ingest

Pub/Sub API (gRPC)

Tooling API

Examples

See the examples directory:

• restapi — SObject CRUD operations
• bulkapi — Query and ingest for large datasets
• toolingapi — Managed event subscriptions
• pubsubapi — Platform events and CDC via gRPC

export SFDC_CREDENTIALS=$PWD/credentials.json
cargo run --example restapi

License

MPL-2.0