API Registration

Owned by Sonali Bhimte (Unlicensed)
Last updated: Sept 14, 2021 by Stuart Glover (Unlicensed)
2 min read

Only the Administrator User Licence can access API Registration.

API Registrations enables you to:

  • Register New Applications

  • View and Manage Applications

In LeadX 2.1 version, the “API Registration” feature is introduced for our valuable customers, so that other applications can access certain internal functions of LeadX. This feature will enable Admin Users to register different applications.

APIs (Application Programming Interfaces) enable software applications to communicate with other pieces of software consistently. Either internally to connect to a component of the application or externally to connect to a service.

Using API-based components and services in development is also a great way of maintaining scalability and productivity as it enables you to develop multiple applications based off of modular and reusable components, allowing scalability and facilitating maintenance.

  • Once you have selected the ‘Know More’ button you open the API Registration feature details as shown below:

 

Register New Application

  • Hit the Register Application button to open window

  • Type in the Application name and hit Generate

  • View and copy Client Id and Secret Key

 

View and Manage Applications

  • Application Name: which displays the name of Applications

  • Client Id: will be available associated with particular application

  • Secret Id: secret remains hidden by default, press view button (eye) to read

  • App Status: shows the status of application. If consumer tries to hit or access the LeadX application and authorization is successful then the status will be Registered, otherwise this will shows status as pending

  • Activate/Deactivate: shows the current status as Active or Deactivate with reference to App status. If application is registered successfully then it will be active otherwise this will be Deactivate.