Document toolboxDocument toolbox

API - Application Programming Interface

Owned by Former user (Deleted)
Last updated: Jan 03, 2023 by Former user (Deleted)
2 min read

API (application programming interface) access to Lucidity Software facilitates the bi-directional flow of information in a secure and structured manner. Each individual use case for API access will vary, common use of the API may include:

  • Management of users, assets, companies from external systems

  • Reading of data for import to external system

The RESTful API has predefined, controlled endpoints that are outlined in the SwaggerHub documentation link below. To access the API a username and password is exchanged for an access token. Each access token is linked to a user that exists on the platform and adheres to the user’s access privileges.

Once authenticated, the API with the correct privileges will:

  • List current organisation structure

  • List available roles

  • Facilitate the creation of new users

  • Update existing user profiles

  • View user profile for one or more users

  • Facilitate the creation of new companies

  • Update existing companies

  • View one or more companies

  • Facilitate the creation of new assets (under development)

  • Update existing assets (under development)

  • View one or more assets (under development)

For documentation and latest updates on the API, please visit our SwaggerHub page:

http://api.luciditysoftware.com.au/

If you would like to set up API access to your organisation's Lucidity Software instance, or you have existing access and would like to request new endpoints, please log a ticket with support@luciditysoftware.com.au and our sales team will provide a quote.

Direct Database Access (Read-only)

In addition to using the API to read records from a Lucidity database, there is an option to use a direct database connection. This is normally implemented for the purposes of a reporting database in conjunction with Power BI or a similar tool, however the database connection is also a very flexible way of extracting data from Lucidity in real time for any interfacing purpose.

More information can be found on the BI reporting and database access page.

 

Related pages:

 

Â