Introduction:
In Salesforce, the Apex programming language provides powerful capabilities to extend and customize the platform. One common requirement is to upload documents or files programmatically to Salesforce using the REST API. In this blog post, we will explore how to accomplish this task by leveraging Apex classes in Salesforce.
Prerequisites:
Before we begin, make sure you have the following prerequisites in place:
- Salesforce Developer Edition or sandbox environment.
- Salesforce API credentials with appropriate access rights.
- Basic knowledge of Salesforce Apex programming language.
Step 1: Setting Up REST API Integration
To start with, we need to set up the REST API integration in Salesforce. Follow these steps:
- Log in to your Salesforce Developer Edition or sandbox environment.
- Navigate to Setup by clicking on the gear icon in the top-right corner.
- In the Quick Find box, search for "API" and select "API Integrations."
- Enable the REST API by checking the "Enable REST API" checkbox.
- Click on "Generate Token" to generate a security token. Make sure to save the token for later use.
Step 2: Writing Apex Class to Upload Documents
Once the REST API integration is set up, we can now write an Apex class to handle the document upload process. Follow these steps:
- In Salesforce, navigate to Setup and search for "Apex Classes."
- Click on "New" to create a new Apex class.
- Provide a suitable name for your class and write the following code:
public class DocumentUploader {
// Replace with your actual Salesforce instance URL
private static final String SALESFORCE_INSTANCE_URL = 'https://your-instance-url.salesforce.com';
// Replace with your actual Salesforce access token
private static final String ACCESS_TOKEN = 'your-access-token';
// Replace with your actual Salesforce document object API name
private static final String DOCUMENT_OBJECT_API_NAME = 'Document';
// Replace with the folder ID where you want to upload the document
private static final String FOLDER_ID = 'your-folder-id';
public static void uploadDocument(String documentName, String base64Data) {
HttpRequest request = new HttpRequest();
request.setEndpoint(SALESFORCE_INSTANCE_URL + '/services/data/v52.0/sobjects/' + DOCUMENT_OBJECT_API_NAME + '/');
request.setMethod('POST');
String boundary = '----------------------------741e90d31eff';
String header = '--' + boundary + '\r\nContent-Disposition: form-data; name="entity_attachment";' +
' filename="' + documentName + '"\r\nContent-Type: application/octet-stream\r\n\r\n';
String footer = '\r\n--' + boundary + '--\r\n';
String body = header + base64Data + footer;
request.setHeader('Content-Type', 'multipart/form-data; boundary=' + boundary);
request.setHeader('Authorization', 'Bearer ' + ACCESS_TOKEN);
request.setHeader('Content-Length', String.valueOf(body.length()));
request.setBody(body);
HttpResponse response = new Http().send(request);
if (response.getStatusCode() == 201) {
System.debug('Document uploaded successfully.');
} else {
System.debug('Error uploading document: ' + response.getBody());
}
}
}
4. Replace `'https://yourinstance.salesforce.com'` with your Salesforce instance URL.
5. Save the Apex class.
In the above code:
- Replace 'https://your-instance-url.salesforce.com' with the URL of your Salesforce instance.
- Replace 'your-access-token' with your actual Salesforce access token. You can obtain the access token using the OAuth 2.0 flow or any other authentication mechanism.
- Replace 'Document' with the API name of your Salesforce document object. It could be 'ContentVersion' or any other custom object you are using to store documents.
- Replace 'your-folder-id' with the ID of the folder where you want to upload the document. If you want to upload it to the root folder, you can use '00lXXXXXXXXXXXX' (replace 'XXXXXXXXXXXX' with your actual org ID).
To use the 'DocumentUploader' class, you can call the 'uploadDocument' method and provide the document name and base64-encoded data as parameters. Here's an example usage:
String documentName = 'MyDocument.pdf';
String base64Data = '...'; // Replace with your base64-encoded document data
DocumentUploader.uploadDocument(documentName, base64Data);
Make sure to replace '...' with the actual base64-encoded data of the document you want to upload.
Please note that this code assumes you have the necessary permissions and access to upload documents in Salesforce.
Conclusion:
In this blog post, we learned how to upload documents using the REST API from an Apex class in Salesforce. By leveraging the capabilities of Apex programming, we can easily extend Salesforce's functionality and automate various processes. Remember to handle error scenarios and add appropriate error handling to ensure the smooth execution of the document upload