Data Ingestion API Testing

Guide to using the feature and creating a sample Data Record in the Model via API Ingestion Integration.

Purpose of use

• Search for information before using the Data Ingestion API feature (creating data on the PangoCDP system via API-based integration).

If you are looking for documentation to perform integration, please access it here.

• Test a data record to review the detailed structure of the Request Payload (pushed data details), and the Respond Result (response returned from Pango),...

• Check for errors that may occur in the data structure or during failed integrations.

• When there is a need to create a few data records in the Pango Model.

Guide to accessing the feature

The Data Ingestion API feature is available on Models, allowing third-party systems to use APIs to ingest data, including all Custom Models and some supported System Models.

When viewing the Model detaildetails, the, feature will be displayed, and it typically appears in the following cases:

• Access the CDP Module and select a Data Model

  • Any Model that belongs to a Custom Model.

  • For system models, when accessed, if the Data Ingestion API is supported, it will be Enabled, if not supported, it will not be displayed

• Click to open the Data Ingestion API interface.

Guide to creating a Data Record

Data Model

When accessing the Data Ingestion API interface, the Data Model tab will be opened. This interface displays the Payload, which contains sample data information stored in the Pango Model in JSON View format.

• Click the Model name to open the Model configuration in the Module Console.

• Copy Payload: Clickto copy the entire Payload structure.

• Attention: important information to note when performing integration includes:

  • User Event: use jeConfigId and jeEventKey to create events when ingesting data into Pango. First, configure the event in: Data Model / [Model Name]/ Data Manipulation / User Event, then copy the Event Id into "jeConfigId" and th Event Key into "jeEventKey".

  • ignoreUpdateCfs: To avoid updating data in specific custom fields, use "ignoredUpdateCfs". For examples, to exclude updates for customField01 and customFieldLong03, configure as follows: "ignoredUpdateCfs": [ "customField01", "customFieldLong03" ]

• Basic data structure:

  • objectType: the model that receives the data

  • source: the data source

  • entries:

    • customField: supports custom fields in multiple formats

    • systemField: fields that are predefined for the Model with mandatory formats and are required for data ingestion.

    

Advanced Config

Provides optional supporting features within the Data Ingestion API flow, click Enable to use. Selecton the interface.

Callback Result

Use this feature to send responses back to the third-party partner system server when data is successfully ingested into the PangoCDP system.

The interface is displayed in the Payload

Beforehand, the third-party partner needs to integrate the Callback data receiving flow from Pango based on this Document.

• Endpoint: enter the address to receive the Callback Result

• API Key: an authentication key used when calling via the third-party system (this key is provided by the partner).

⇒ When ingesting data into PangoCDP, the system will return a Success/Fail result to the partner’s system based on Endpoint andauthenticated API Key.

User Event

Use this feature to create 01 User Event when a Data Record is successfully ingested into the Model.

Displayed within the Payload section

Note: This option is only available for supported Models. The User Event trước must be configured in advance in the Data Model on the Module Console, You can quickly access via

• User Event Name: select a configured User Event to add to the Data Ingest structure - only Events with Active status will be displayed.

• User Event ID: the identifier of the User Event, which is automatically displayed after selecting the User Event Name.

• User Event Key: a unique key that is automatically displayed after selecting the User Event Name

Pango Webhook

Use this feature to create Webhook requests that have been configured and send them to the third-party partner system.

Interface configuration displayed within the Payload section

Note: This option is only displayed for supported Model. To use this feature, the Webhook Status must be set to Enabled and API Trigger must be set to Yes. You can quickly access via

• Webhook Connection: select a configured Webhook Connection.

• Webhook Event: select the Event to be created on the configured Webhook Connection

Test Ingestion

Authentication

Declare the authentication mechanism when ingesting data into the Pango system, including:

• App Connect: select a created account - with data transmission permission, then click Manage App to open the interface for creating an App Connect.

• Get Token: click the Get Token button to generate an authentication token when adding data into the system - note: the token can only be generated after selecting App Connect.

• Your Token: the token generated after clicking Get Token.

API Information

Provides information used for integrating data into the Pango Model, click Extend Document to view detailed API documentation:

• Endpoint: the destination for receiving data.

• Method: the method used to transmit data (Post: pushes data from external systems into the model).

• Request Parameters: system information - request parameters used to determine the target of data ingestion.

• Content-type: system information - the data type that will be ingested into the system.

Request Body

Transmit data for test Ingest into the Model and its data fields, including:

• Custom Field: fields that operators add to the Model

• System Field: fields that are predefined by the system in the Model

Different Models will have completely different System Fields and Custom Fields.

Note: for Models being ingested, certain required fields (momCode, refId...) must be provided depending on specific requirements. In addition, operators must ensure that the data format matches the corresponding Fields (for example: customField - string, customFieldTimestamp - float,...)

Please complete all required fields and add additional information if needed so that the system can ingest the data. After completing the input ⇒ clic Execute to perform a test integration .

Response Result

The response returned when ingesting data into the Model being executed, helps the integration side easily check issues before the integration process. Click Copy response to copy the response result.

A successful integration can be verified by checking the field "success": true

When integrating into the system, if issues occur, will be returned in the Response Result. Depending on the integration context or the Model being ingested, the encountered errors may vary - these errors are provided in detail within the Response.

Note: Check the "success" field: true/false to quickly determine the result ⇒ continue reviewing other fields to understand the details.

FAQ/Tips

Open the Pango Help Center to compile frequently asked questions when working with the Data Ingestion API (content is continuously updated and expanded by the Pango team).

Summary

The Data Ingestion API feature allows users and third-party systems to push data directly into Data Model on PangoCDP via APIs. This is an essential tool that enables operators This is an essential tool that enables operators to independently test data and handle integration errors without requiring support from the Tech Team, from simple to complex scenarios, including:

• Previewing the data structure to be transmitted (Request Payload).

• Checking responses returned from the Pango system during ingestion.

• Advanced configuration, such as creating user events (User Event), triggering webhooks, and sending callback responses to external systems.

The usage process includes:

1. Access the Data Ingestion API tab within each Model in the CDP Module.

2. Correctly declare the Request Body, including the appropriate System/Custom Field.

3. Use the configured App Connect to generate a Token.

4. Perform a test ingestion and check the returned result (Response) to ensure the data is valid.

5. Optionally configure additional supporting actions (Webhook, Callback, User Event) if required by the integration needs.

This is a flexible tool for operations teams or integration partners who need to quickly create data in the system, ensuring data standards are met from the feasibility testing stage, error investigation