Legal Disclaimer: The resource assets in this website may include abbreviated and/or legacy terminology for HPE Aruba Networking products. See www.arubanetworks.com for current and complete HPE Aruba Networking product lines and names.
API Gateway
The feature in HPE Aruba Networking Central On-Premises supports the REST Representational State Transfer. REST is a simple and stateless architecture that the web services use for providing interoperability between computer systems on the Internet. In a RESTful web service, requests made to the URI of a resource will elicit a response that may be in XML, HTML, JSON or some other defined format. API Application Programming Interface. Refers to a set of functions, procedures, protocols, and tools that enable users to build application software. for all HPE Aruba Networking Central On-Premises services. This feature allows HPE Aruba Networking Central On-Premises users to write custom applications, embed, or integrate the APIs with their own applications. The REST APIs support HTTP Hypertext Transfer Protocol. The HTTP is an application protocol to transfer data over the web. The HTTP protocol defines how messages are formatted and transmitted, and the actions that the w servers and browsers should take in response to various commands. GET GET refers HTTP request method or an SNMP operation method. The GET HTTP request method submits data to be processed to a specified resource. The GET SNMP operation method obtains information from the Management Information Base (MIB). and POST The HTTP POST method is used for transferring data from a client (browser) to a server using the HTTP protocol. The POST method is considered a secure way of transferring data from a client as it carries the request parameter in the message body and does not append it in the URL string. operations by providing a specific URL Uniform Resource Locator. URL is a global address used for locating web resources on the Internet. for each query. The output for these operations is returned in the JSON JavaScript Object Notation. JSON is an open-standard, language-independent, lightweight data-interchange format used to transmit data objects consisting of attribute–value pairs. JSON uses a "self-describing" text format that is easy for humans to read and write, and that can be used as a data format by any programming language. format.
In HPE Aruba Networking Central On-Premises, the API Gateway is available in 3N (3-node) and above cluster setup. The API Gateway is not available in a 1-node cluster setup.
For secure access to the APIs, the HPE Aruba Networking Central On-Premises API Framework plug-in supports the OAuth protocol for authentication and authorization. The access tokens provide temporary and secure access to the APIs. The access tokens have a limited lifetime for security reasons and the applications use the refresh API to obtain new tokens periodically (every 2 hours).
- To access the API Gateway interface, you must ensure that the FQDN Fully Qualified Location Name. FQLN is a device location identifier in the format: APname.Floor.Building.Campus. in the API Gateway URL resolves to the same IP address as the HPE Aruba Networking Central On-Premises server.
- To avoid any error in the server certification, make sure that you include the API gateway FQDN as a Subject Alternate Name (SAN) in the certificate.
The following figure illustrates the API gateway workflow for the users:
This section includes the following topics:
