Blog |
Guides

5 best practices for API consumption with SSJS

19/7/2023

‍

5 good practices for the consumption of APIs with SSJS in Salesforce Marketing Cloud

‍

Salesforce Marketing Cloud (SFMC) is a Marketing Automation tool used by organizations. It has several tools, both declarative (point-and-click) and programmatic (with code). Among the languages exclusive to Marketing Cloud is Server Side Javascript. This language is the best option if AMPscript does not meet the requirements for the use case to be developed, including the consumption of APIs, either from Salesforce Marketing Cloud or external APIs.

Being an ideal programming language for these cases, it is necessary to take into account the best practices when developing it. In this blog we will explore 5 best practices that you can implement in your Marketing Cloud development team.

‍

‍

1. Secure your credentials

Building applications within Marketing Cloud represents a challenge, since it does not have an adequate infrastructure to generate credentials. However, there are tools that allow us to overcome this limitation through "workarounds". As it is not a tool 100 percent dedicated to the applications generated in Cloud Pages, we must take certain precautions, such as the use of credentials, use the appropriate ones and store them in a secure and effective way.

‍

For this, we recommend the following:

  1. Create a Data Extensions with your credentials for server-to-server integrations.
  2. Use the AMPscript EncryptSymmetric function to store them in the same Data Extension.
  3. To obtain the token (or keys to request a token) you can use the Lookup functions to search the same Data Extension from step 1 and DecryptSymmetric to decrypt.
%%[
SET @lookUp = LookupRows('API_Integrations','Name','JourneyAPI')
SET @rowResult = Row(@lookup,1)
SET @clientId = DecryptSymmetric(Field(@rowResult,'Client Id'),'aes', 'INT_PWD', @null, 'INT_SALT', @null, 'INT_IV', @null)
SET @clientSecret = DecryptSymmetric(Field(@rowResult,'Client Secret'),'aes', 'INT_PWD', @null, 'INT_SALT', @null, 'INT_IV', @null)
SET @tenantId = Field(@rowResult,'Tenant Id')
SET @oldToken = DecryptSymmetric(Field(@rowResult,'Token'),'aes', 'INT_PWD', @null, 'INT_SALT', @null, 'INT_IV', @null)
SET @expirationDate = Field(@rowResult,'ExpirationDate')
]%%

2. Use try... catch

Whenever we are going to query any API via SSJS, we have the advantage of try...catch blocks. This practice helps us to generate an error log (as we will see later) and do a correct error handling, like sending to an errorpage to our users. 

It is important to note that not all code should be wrapped in a try...catch, but, only what may represent a risk to our code or logic.‍‍‍‍‍
‍‍
//Código para preparar nuestro llamado
var req = new Script.Util.HttpRequest("http://www.example.com/");
req.emptyContentHandling = 0;
req.retries = 2;
req.continueOnError = true;
req.setHeader("headerTest", "test header value");
req.method = "POST";
req.postData = "testing=testValue1";
try {
//Llamado API
var resp = req.send();
} catch (e) {
SendLog(e.message)
Redirect(errorPage, true)
}

Generate an error log

Another good practice is to have a Data Extension that contains at least the following data:

  1. Id column
  2. Error date and time column
  3. Identifier column of the script that presented the error (this allows scalability in the development).
  4. Emergency column
  5. Text column that allows to save a JSON with variable information, depending on the API or script call to have the full context of the error.

This Data Extension can also be linked to a backup process through Automation Studio and e-mail alerts can be set up.

‍

4. Use the HttpRequest object

Within SSJS we have three ways to make HTTP calls: 

  1. HTTP.Post and HTTP.Get
  2. Platform.Function.HTTPGet and Platform.Function.HTTPPost
  3. Script.Util.HttpRequest

To make API calls, it is recommended to use Script.Util.HttpRequest since it has the advantage of having a better error handling and the object construction is easier and very flexible, compared to the other two options. 

Script.Util.HttpRequest has other HTTP methods such as Delete, Put, Patch, Head and Options, besides having the continueOnError property that allows us an optimal handling of errors and new attempts for API queries, which can be configured with the retries property.

Still, HTTP.Post, HTTP.Get, Platform.Function.HTTPGet and Platform.Function.HTTPPost are good choices for simple calls or scripts that have a short lifetime and/or require time maximization when developing.

‍

5. Use the JSON Code Resource

One of the big differences between Sales Cloud and SFMC development is the possibility of exposing web services and extending integrations. In SFMC, there is no standard way, however, there are some workarounds through SSJS and AMPscript, one of those is the use of JSON Code Resources, which can execute SSJS, and therefore, write a JSON as a response that allows communication with various systems, both as a webhook and as a custom endpoint in SFMC.

‍

‍

By following these 5 best practices for API consumption with SSJS at Salesforce Marketing Cloud, you will be able to optimize your developments and ensure reliable operation of your integrations. Secure your credentials, use try...catch blocks to handle errors, log and manage errors in a Data Extension, leverage the HttpRequest object to make API calls and explore the use of the JSON Code Resource to extend your integrations.

‍

Want to know more? contact us!

‍

‍

Alfredo Ledesma

6x Salesforce Certified

RECENT ENTRIES

Guides

Should you trust Artificial Intelligence? Security and Transparency with Salesforce and Orange Digital

In the digital age, trust in artificial intelligence (AI) is crucial. Salesforce stands out for its focus on trustworthy and ethical AI, and at Orange Digital we follow similar principles to protect your data and ensure responsible use of AI. We explore how Salesforce builds this trust through data quality, human oversight and training, and how Orange Digital implements strict data protection policies and customized solutions. Find out more about how our solutions can transform your business with secure and trusted AI.
READ MORE
Guides

Everything You Need to Know About Salesforce Einstein

Salesforce Einstein, Salesforce's artificial intelligence technology, has become an indispensable tool for companies that want to make the most of their data and improve the customer experience. From personalizing interactions to making informed decisions, Einstein transforms the way businesses operate. At Orange, we not only implement these tools, but we offer ongoing support to ensure that your company takes full advantage of Salesforce Einstein's capabilities. Find out how we can help you take your business to the next level with Salesforce Einstein!
READ MORE
Guides

TikTok and WhatsApp: The New Integrations of TikTok and WhatsApp Salesforce Marketing Cloud

In an ever-evolving digital world, businesses need to connect with their customers in a more effective and personalized way. Discover how the new TikTok and WhatsApp integrations with Salesforce Marketing Cloud can transform your marketing and customer service strategy, generating high-quality leads and improving customer engagement. Learn how Orange can help you leverage these powerful tools to drive growth and differentiation for your brand.
READ MORE