Get Started with Campaign APIs gs-ac-api
ÃÛ¶¹ÊÓƵ Campaign comes with a set of Javascript functions which you can use:
- in Scripts - in ÃÛ¶¹ÊÓƵ Campaign workflows
- via APIs - from external systems
You can use JavaScript APIs to write in Campaign cloud database or read from the database:
- Business-specific APIs that let you act on each object: deliveries, workflows, subscriptions, and so on. Learn more in Campaign Classic v7 documentation.
- Generic data access APIs for querying the data model data. Learn more in Campaign Classic v7 documentation.
Note that in its Enterprise (FFDA) deployment, Campaign works with two databases: a local database for the user interface real-time messaging and unitary queries and write through APIs, and a Cloud database for campaign execution, reporting, data ingestion, batch queries and workflow execution.
-
As a Campaign user transitioning from Campaign Standard, you can use REST APIs with Campaign v8. Learn more.
-
Starting Campaign v8.5.1, the authentication process to Campaign v8 changed. Technical operators must use ÃÛ¶¹ÊÓƵ Identity Management System (IMS) to connect to Campaign. Learn how to migrate your existing technical account(s) in this technote.
-
ÃÛ¶¹ÊÓƵ Campaign v8 comes with a limit on the throughput (TPS) of our API layer. Breaking the limit leads to standard HTTP error (429). As a Managed Cloud Services user, you can contact ÃÛ¶¹ÊÓƵ to adapt the throttling for each API.
Prerequisites ac-api-prerequisites
Before using ÃÛ¶¹ÊÓƵ Campaign APIs, you need to be familliar with the following topics:
- JavaScript
- SOAP protocol
- ÃÛ¶¹ÊÓƵ Campaign data model
In order to use APIs and interact with ÃÛ¶¹ÊÓƵ Campaign, you also must be familiar with your data model.
Related topics