Getting started guide

ACTIVE NET Insights Data API provides access to low level historical transaction data to provide more flexibility in deciding how to display / render the information. ACTIVE Net Insights Data APIs can simplify technical integration of ACTIVE Net Insights into a customer’s ecosystem to provide more value.

 

ACTIVE Net Insights Data APIs are provided as a RESTful Web service. Representational state transfer (REST) is a method of providing interoperability between computer systems on the Internet. For more information about REST, refer to https://www.w3.org/TR/2004/NOTE-ws-arch-20040211/#relwwwrest.

 

ACTIVE Net Insights Data APIs are based on open standards. You may use any web development language to access ACTIVE Net Insights Data APIs.

ACTIVE Net Insights Data APIs use the standard HTTP GET method and JSON for both request and response formats.

 

 

Using ACTIVE Net Insights Data APIs

ACTIVE Net Insights Data APIs allow your application to access current data within ACTIVE Net Insights. Several common operations can be performed on ACTIVE Net Insights Data objects.

 

Operation Support
create -- Create a new object with the specified parameters.

No

read -- Retrieve data from the specified object.

Yes

query -- Retrieve objects matching the specified criteria.

Yes

update -- Update data in an existing object.

No

upsert -- Update data in existing object if it exists. If the object does not exist, then create one using the specified parameters.   No

 

Developers must authenticate with the API before issuing requests. Refer to Authentication for details.

Getting started now

Integration checklist

Use the following checklist to identify the tasks required for a successful integration with ACTIVE Net System APIs.

Item Integration task
1

Contact the ACTIVE Net support team (activenetsupport@activenetwork.com) to:

 

For existing API users to enable the enhanced-security ACTIVENet System APIs, refer Here.

 
2 Develop your client application for calling the API and receiving responses:

Note:

Insights Data APIs are not available on the Trainer site.

 

For more information about network security, refer to Network security.

 
3 Test your client application  

Network security

To secure network connections, the HTTPS protocol must be used to call ACTIVE Net System APIs. The HTTPS protocol supports TLSv1.2, TLSv1.1 and TLSv1.0.

 

Related topics

Authentication

Retrieving data from ACTIVE Net Insights

Common parameters

Error handling

Terms of Use