Connecting with Salesforce

In order to make calls against the Salesforce Rest API you need to provide ts-force with an accessToken and an instanceUrl. How you obtain the access token is left up to you. ts-force does provide some functions for obtaining access tokens for common oAuth flows.

The Rest Class

The Rest class is responsible for making requests against Salesforce. The generated classes and Composite API clients use this class to make requests.

The Rest class is really just a wrapper for an Axois instance. You can access the raw Axois instance to add Interceptors and Adapters via the request member.

See Re-Auth on Token Expiration for an example.

Default vs Instance Connections

Default Connection

If you are only working with a single connection with straight-forward use cases you might find it more convenient to set the "default" configuration:

setup.ts

import { setDefaultConfig } from 'ts-force';

setDefaultConfig({
   accessToken: 'abc123',
   instanceUrl: 'https://na3.salesforce.com'
});

doSalesforceStuff.ts

import { Rest, CompositeCollection } from 'ts-force';

//all of these are automatically setup with the default connection
const client = new Rest();
const collection = new CompositeCollection();
const myAccount = new Account();

Multiple (Managed) Connections

If you need more control or are using multiple Salesforce orgs then you'll need to explicitly setup Rest clients.

doSalesforceStuff.ts

import { Rest } from 'ts-force';

const restInstance = new Rest({
   accessToken: 'abc123',
   instanceUrl: 'https://na3.salesforce.com'
});

const secondaryRestInstance = new Rest({
   accessToken: 'abc123',
   instanceUrl: 'https://na3.salesforce.com'
});

//create a collection client for the primary connection
const collection = new CompositeCollection(restInstance);

// account connected to primary instance
const primaryAcc = new Account({name: 'foo'}, restInstance);

//query accounts on the secondary instance
const secondaryAcc = await Account.retrieve(f => ({
  select: ['name'],
  limit: 1
}), {restInstance: secondaryRestInstance});