Get Started with Campaign APIs

Adobe Campaign comes with a set of Javascript functions which you can use:

  • in Scripts - in Adobe Campaign workflows
  • via APIs - from external systems

You can use JavaScript APIs to write in Campaign cloud database or read from the database:

Campaign v8 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.

CAUTION

Adobe 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 Adobe to adapt the throttling for each API.

Prerequisites

Before using Adobe Campaign APIs, you need to be familliar with the following topics:

  • JavaScript
  • SOAP protocol
  • Adobe Campaign datamodel

In order to use APIs and interact with Adobe Campaign, you also must be familiar with your data model.

NOTE

You can generate a complete description of your data model. Learn more in this page.

Campaign API staging mechanism

With Campaign Cloud database, blast unitary calls are not recommended due to performance (latency & concurrency). Batch operation is always preferred. In order to guarantee optimal performances of APIs, Campaign keeps handling API calls at the local database level.

API staging mechanism is detailed in this page

New APIs

New APIs are available to manage data synchronization between Campaign local database and Cloud database. A new mechanism has also been introduced to handle API calls at the local database level to avoid latency and increase the overall performance.

New APIs are detailed in this page

Related topics

On this page