Private APIs

Private APIs are lightweight GET APIs created to fetch specific data that’s not available through standard APIs and can be used through Neo dataflow. Neo acts as the orchestration layer to call these private APIs. Additionally, you can expose a private API as a public endpoint through Neo and make it a Global API, allowing external systems to access it directly. These APIs help to address custom requirements without modifying existing standard APIs available.

Note: Private APIs can be used only to retrieve data.

Example use case

Scenario

You want to run a targeted campaign for customers whose loyalty points expired in the current month. These emails will highlight the expired points to encourage future engagement and redemption.

Challenge

The standard APIs only return active (available) points. They do not provide information on expired points.

Solution

• Create a private API that retrieves expired loyalty points for a given customer.

• Integrate this API in a Neo dataflow to:

  1. Identify eligible customers.
  2. Fetch expired points using the private API.
  3. Personalise the campaign message with the expired points data.
  4. Trigger email delivery using Engage or an external system.

Status Codes

The following are the success and error codes associated with Private APIs.

Success Code

Error Codes