Introduction
The Enterprise API (EAPI) is a component that facilitates seamless integration and interaction with various internal and external applications. The purpose of this article is to provide a brief overview of the EAPI, highlighting its capabilities and the data required from users to efficiently utilize it.
What is EAPI?
EAPI designed to provide access to methods within the enterprise_utils package of the database. Operating via JSON_RPC protocol over HTTP(S), EAPI is crucial for connecting with in-network applications of the system owner, including integration with other Alaris Labs products like HLR Proxy Configurator, Campaign Portal, mKit, and SMS Firewall.
Key Features of EAPI
- Restricted and Extensive Modes: EAPI can operate in a standard mode with limited access or in a "god mode" offering full access to all DB API methods. The creation of a separate
enterprise_utilspackage ensures backward compatibility for client-facing APIs with each new product version.
Difference from REST API:
A REST API is provided for partners and clients of the system owner, also serving as the backend for the Old Campaign Portal. In REST API, unlike EAPI, not all methods are present. This is necessary for security.
Implementation and Access
EAPI is installed upon client request. Please contact Alaris support if you need to install this module.
The enterprise_utils package accompanies database updates, while the documentation and EAPI itself are installed on a machine with web access.
Information Required from Clients
To effectively set up and utilize EAPI, clients need to provide:
- IP List: A list of IPs that should have access to the API, or a decision to make the API accessible to all.
- Domain Information: The domain where the Enterprise API will be accessible. Domain should be pointed to your VIP address.
Users and Roles
Role Assignment: Applications using EAPI must operate through a user assigned with the ROLE_EP in the Enterprise API web interface. Without this role, authorization in EAPI is not possible.
- Role Verification: Additionally, for methods accessed through EAPI, the same roles checked in the main part of the DB API are also verified.
Operational Mechanics
Each EAPI request initiates an Oracle session for all database communications, followed by an authorization process (via the login method). After executing the primary DB query, a logout method is called, concluding with the closing of the DB session.
AKBSMS - Alaris Knowledge Base
Related Questions:
What is Enterprise API (EAPI) in Alaris Labs systems?
How does EAPI facilitate integration with Alaris Labs products?
What is the functionality of EAPI?
How does EAPI ensure backward compatibility in Alaris Labs products?
In what modes can EAPI operate and what are their differences?
What is the role of the REST API in relation to EAPI for Alaris Labs clients?
How is the EAPI project structured within Alaris Labs systems?
What are the installation requirements for EAPI in client systems?
What user roles and permissions are needed to access EAPI?
What information do clients need to provide for EAPI setup?
Why is the role of ROLE_EP important for using EAPI?
Can EAPI be made accessible to all IP addresses or is restricted access recommended?
What are the operational mechanics of an EAPI request in Alaris Labs systems?
Link to this article: https://helpdesk.alarislabs.com/en/knowledge_base/article/309/category/144/