Skip to content
master
Switch branches/tags
Code

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Call REST API from Lightning Aura Components without Named Credentials

A simple promise-based service component for working with Salesforce REST API and JavaScript Fetch API directly from your aura component's JavaScript without you needing to write Apex or configure Named Credentials. Just install and use.

📝 Table of Contents

🚨 Prerequisites

  1. Enable Lightning Experience
  2. Enable My Domain
  3. Allow IFraming of Visualforce Pages with Clickjack Protection

You can find step-by-step instructions with screen shots in the Mass Action Scheduler wiki, which is my primary app that uses this component.

👋 Getting Started

  1. Deploy this project to your org (you only need what's in force-app folder).

    git clone https://github.com/douglascayers/sfdx-lightning-api-component.git
    
    cd sfdx-lightning-api-component
    
    sfdx force:org:create -a lapi -s -f config/project-scratch-def.json
    
    sfdx force:source:deploy -u lapi -p force-app
    
  2. Explore the LC_RequestDemo and LC_FetchDemo components in the force-demo folder on usage.

  3. Try out a demo

    sfdx force:source:deploy -u lapi -p force-demo
    
    sfdx force:user:permset:assign -n LC_Demo
    
    sfdx force:org:open -u lapi -p //lightning/n/LC_Demo
    

    a. Assign yourself the LC Demo permission set.

    b. Navigate to the LC Demo tab.

    c. Play with the sample components to send different REST API and Fetch API requests.

    d. Marvel that you didn't have to write any Apex code or configure a Named Credential :)

📘 Example Usage

Add the <c:lc_api> to your aura component and give it an aura:id for reference.

<!-- YourComponent.cmp -->
<aura:component>
    <c:lc_api aura:id="lc_api"/>
    ...
</aura:component>

Find the <c:lc_api> by its aura:id then call one of the request methods:

  • The restRequest(..) method passing in a JSON object with the url, method, body, and any headers properties, or
  • The fetchRequest(..) method passing in a JSON object with the url and options properties
// YourComponentController.js
({
    createAccount: function( component, event, helper ) {

        component.find( 'lc_api' ).restRequest({
            'url' : '/services/data/v47.0/sobjects/Account',
            'method' : 'post',
            'body' : JSON.stringify({
                "Name" : "LC Demo Account"
            })
        }).then( $A.getCallback( function( response ) {
            // handle response
            // { id: "001f400000YEZB8AAP", success: true, errors: [] }
        })).catch( $A.getCallback( function( err ) {
            // handle error
        }));

    },

    getDataFromGist: function( component, event, helper ) {

        component.find( 'lc_api' ).fetchRequest({
            'url' : 'https://gist.githubusercontent.com/douglascayers/e96c53304dc78dc83e59a85753f29111/raw/sfdx-mass-action-scheduler-version.js',
            'options': {}
        }).then( $A.getCallback( function( response ) {
            // handle response
        })).catch( $A.getCallback( function( err ) {
            // handle error
        }));

    }

})

💎 Sponsoring

This project is a free-as-in-speech and open source developed passion project of Doug Ayers.

If you've found value in my open source projects, please consider showing your support:

Thank you! ❤️

https://douglascayers.com/thanks-for-your-support/

🙏 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

For code contributions, please follow the GitHub flow:

  1. Fork this project and install the source code.
  2. Create your feature branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -m 'Add some AmazingFeature').
  4. Push to your feature branch (git push origin feature/AmazingFeature).
  5. Open a pull request to the develop branch.

🧐 Troubleshooting

"Access Denied" or "No 'Access-Control-Allow-Origin' header is present on the requested resource. Origin 'https://yourinstance.visualforce.com' is therefore not allowed access."

Your request was blocked due to Cross-Origin Resource Sharing (CORS) policy.

This can happen when trying to make a request to /services/apexrest/ endpoint. For example, the Visualforce domain hosting LC_APIPage is on https://yourinstance.visualforce.com and is trying to make a web request to https://yourinstance.my.salesforce.com/services/apexrest/. Because the two domains do not match, then CORS policy prevents the request.

  1. In Setup, navigate to Security | CORS.

  2. Add the origin URL mentioned in your error message (e.g. https://yourinstance.visualforce.com) to the list of whitelisted domains.

✍️ Authors

Doug Ayers develops and maintains the project.

See also the list of contributors who participated in this project.

🎉 Acknowledgements

Penpal for a secure, promise-based library for communicating between windows and iframes.

jsforce for an elegant, promise-based library for working with Salesforce REST API.

🎈 Other Utilities

You should check out sfdc-lax by Ruslan Kurchenko, a promise-based service component that makes calling Apex actions or using Lightning Data Service a breeze.

👀 License

The source code is licensed under the BSD 3-Clause License