ACTIVE NET System APIs provide access to low level configuration data to provide more flexibility in deciding how to display / render the information. ACTIVE Net System APIs can simplify technical integration of ACTIVE Net into a customer’s ecosystem to provide more value.
ACTIVE Net System 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 System APIs are based on open standards. You may use any web development language to access ACTIVE Net System APIs. ACTIVE Net System APIs use the standard HTTP GET method and JSON for both request and response formats.
ACTIVE Net APIs allow your application to access current data within ACTIVE Net. Developers must authenticate with the API before issuing requests. Refer to Authentication for details.
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:
For more information about network security, refer to Network security.
To try ACTIVE Net System APIs without affecting the Live site, you can use the Trainer site to develop your application for calling the API and receiving responses: Note:
|
|
| 3 | Test your client application
If you encounter any errors, refer to Error handling. After completing testing, you can replace the Trainer site organization ID and API key with the Live site organization ID and API key to retrieve live data. |
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.
Retrieving data from ACTIVE Net
Creating and updating data in ACTIVENet