NetAccessAPI

From IP3 TAC

Using NetAccessAPI, information can securely be extracted and manipulated using any XML compliant programming tool for reporting, and subscribers can be managed and the configuration of the IP3 NetAccess platform controlled using the same tools, allowing an unprecedented amount of flexibility and control for integration with users’ billing, management and authentication systems.

Notes Regarding NetAccessAPI:

• NetAccessAPI requires firmware version 4.2.4.2 or later to be running on the NetAccess.
• The NetAccessAPI module needs to be enabled on the NetAccess(es) to be managed. This is an optional module available for purchase.
• The NetAccessAPI module and the NetAccess Central Manager module cannot be enabled at the same time on any unit.
• The NetAccess supports communication to its API via HTTP and HTTPS.
  • All XML transactions must take place via HTTPS to TCP port 9098 on the NetAccess’s Outside IP address.
  • Any files transferred to/from the NetAccess are transferred over HTTP on TCP port 1111.
  • Also as part of the connection URL the /admin/ subdirectory must be specified to access the API parsing engine correctly.
  • It is important to note that in order for external systems to access the NA XML API that both TCP ports 1111 and 9098 will need to be allowed from the managing stations IP address to the public (Outside) IP address of the NetAccess.

Example URL formatting for access to the NA API parsing engine

HTTP = http://(na.public.ip.address):1111/admin/

HTTPS = https://(na.public.ip.address):9098/admin/

Download the NetAccessAPI DTD: Media:NetAccessAPI.dtd

Download the NetAccessAPI DTD Documentation: Media:NetAccessAPI.doc

NetAccessAPI Development Kit