README.md 3.15 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
CONTENTS OF THIS FILE
=====================

 * Introduction
 * Requirements
 * Installation
 * Configuration
 * Usages
 * Troubleshooting
 * Faq
 * Maintainers


INTRODUCTION
============
16
17
18
19
20

This suite of modules supports 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:

21
22
23
24
25
26
27
28
29
30
 * Address
 * Assets
 * Campaigns
 * Contacts
 * Data Events
 * Interaction
 * Messages
 * Platform
 * Push
 * SMS
31
32
33

This module is intended for module developers.

34
35
36
37
38
39
40
41
42
43
44
45
46
47

REQUIREMENTS
============


CORE
----

 * [Drupal Core >= 8.5](https://www.drupal.org/project/drupal)


3rd Party
---------

48
49
These should be automatically installed by composer when you install this
module.
50
51
52
53

 * [Swaggest PHP Json Schema](https://github.com/swaggest/php-json-schema)


54
55
56
57
58
59
60
61
62
63
RECOMMENDED
-----------

 * [Markdown](https://www.drupal.org/project/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.


64
65
66
OBJECTIVES
==========

67
68
69
70
71
72
73
74
75
76
77
78
79
80
There are a lot of API calls available in the Salesforce Marketing Cloud API.
This module aims to provide all of them as a service 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, a decision was made early on in the development to
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.

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


85
86
SIMILAR PROJECTS
================
87
88


89
90
SALESFORCE
----------
91
92


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

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


101
102
EXACT TARGET API
----------------
103

104
105
106
Provides abstraction of the ExactTarget XML API for use by other modules. By
itself, this module provides no functionality and should only be installed if
another module requires it as a dependency.
107

108

109
110
SUPPORT
=======
111

112
Updates to the Json Schema are welcome.
113

114
A community documentation page is available on
115
[www.drupal.org/docs/8/modules/marketing-cloud](https://www.drupal.org/docs/8/modules/marketing-cloud). Please
116
add your notes on solving issues and configuring the module there.
117

118
119
120
121
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.
122
123
124
125
126


MAINTAINERS
===========

127
 * [john_a](https://drupal.org/user/2573976)