Lightning Components Developer Guide

What is the Lightning Component Framework?
Quick Start
Creating Components
Using Components
Communicating with Events
Creating Apps
App Overview
Designing App UI
Creating App Templates
Developing Secure Code
Styling Apps
Using JavaScript
JavaScript Cookbook
Using Apex
Lightning Data Service (Beta)
Lightning Container (Developer Preview)
Using a Third-Party Framework
Lightning Container Component Limits
The Lightning Realty App
lightning-container NPM Module Reference
addMessageErrorHandler()
addMessageHandler()
getRESTAPISessionKey()
removeMessageErrorHandler()
removeMessageHandler()
sendMessage()
Controlling Access
Using Object-Oriented Development
Using the AppCache
Distributing Applications and Components
Debugging
Fixing Performance Warnings
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

getRESTAPISessionKey()

Returns the Salesforce REST API session key.

Use this method when your embedded app needs to interact with the Salesforce REST API, such as executing a SOQL query.

Sample

Used within a JavaScript app uploaded as a static resource and referenced by lightning:container, this example gets the REST API session key and uses it to execute a SOQL query. 
1componentDidMount() {
2  let sid = LCC.getRESTAPISessionKey();
3  let conn = new JSForce.Connection({accessToken: sid});
4  conn.query("SELECT Id, Name from Account LIMIT 50", this.handleAccountQueryResponse);
5}

You can view and download this example in the Developerforce Github Repository.

Arguments

None.

Response

Name Type Description
key string The REST API session key.