API Guide - LiquidAnalytics/ld-api-examples GitHub Wiki

API guide

Getting Started

In order to use Liquid Platform REST API the follow pre-requisites are required:

1. Valid Liquid Platform community
2. OAuth2 client id issued by Liquid Platform
3. OAuth2 client secret issued by Liquid Platform
4. Credentials for the user authorized as a member of your community

Obtaining Liquid Platform OAuth2 Access Token

All API calls require a valid OAuth2 access token. This token should be cached by the calling application. It may expire over time based on community configuration, in which case it will need to be refreshed.

Sending Data to Liquid Platform

Use Upsert API to send updates, creates, and deletes to Liquid Platform.

Replicating Updates

Use Updates and Deletes API to get records that have been updated or deleted since last call.

Creating a Transactions Endpoint

Use JSON Transactions Interface to allow LD to submit transactions against non-LD endpoints.

Summiting Batch Import Jobs

Use Batch Import and Export to submit batch import jobs to Liquid Platform.

Configuring Insight Pop using Mission Control

User InsightPop to get the basic information of how to use Mission control and how to configure application using Mission Control.