Salesforce Marketing Cloud API Integration

Introduction

This suite of modules provides services to all of the Salesforce marketing cloud APIs, and validates all payloads against Json Schema. The following API resources are available in sub-modules:

• Address
• Assets
• Campaigns
• Contacts
• Data Events
• Interaction
• Messages
• Platform
• Push
• SMS

This module is intended for module developers.

Requirements

Core

• Drupal Core >= 8.5

3rd Party

These should be automatically installed by composer when you install this module.

• Swaggest PHP Json Schema

Recommended

• Markdown

This is used to render the module info pages from the markdown code. If not installed, you will still be able to view the info pages, but they will be rendered as plain text.

Objectives

There are a lot of API calls available in the Salesforce Marketing Cloud API. This module provides all of them as services in one place.

The different sections of API have been separated into sub-modules, to allow lighter weight in Drupal and for developers using this as a sub-module, to select which services they want to be available.

The JSON body objects in API calls can often be very complex and potentially infinite depth. Therefore, the module does not provide service functions that have individual input variables and then render the JSON from that. Instead, it is up to the developer to produce the JSON object, and the service will then validate the JSON object against the schema to make sure that it meets minimum requirements.

The schema can be edited and validated, and Json validation can we switched on/off in the settings.

Similar projects

Salesforce

This suite integrates with Salesforce by asynchronously synchronizing Drupal entities (E.g., users, nodes, files) with Salesforce objects (E.g., contacts, organizations, opportunities).

However it uses Salesforce OAuth, which is an entirely different endpoint to Marketing Cloud, and requires different credentials.

ExactTarget API

Provides abstraction of the ExactTarget XML API for use by other modules, and is in the process of being ported to D8. By itself, this module provides no functionality and should only be installed if another module requires it as a dependency.

Support

Updates to the Json Schema and the code are welcome.

Drupal 8

Release 8.x-1.1 supports 8.5+

Drupal 9

Release 8.x-1.3 and above supports 8.8+ and Drupal 9

Drupal 10

Release 8.x-1.8 and above supports Drupal 9/10

A community documentation page is available on Drupal.org. Please add your notes on solving issues and configuring the module there.

Please search the issue queue before filing an issue, and update to latest development release to make sure your problem has not already been fixed. Issues filed using the issue summary template will receive priority over other issues.