Neptune DXP as a platform administration

Access to Neptune DXP’s functions to manage, coordinate, and observe the platform’s operation can be made via the Neptune DXP Cockpit, a friendly screen-based user interface or core APIs a REST API to programmatically automate its functions.

Core APIs

Another access mechanism to administer or configure the Neptune DXP platform is through the use of Core APIs providing programmatic access to the Neptune DXP platform. Whilst the Cockpit provides full access to all the functions available, it is often necessary to produce complex scripts where the execution sequence is best served through automation.

Core APIs can be selectively imported into your Neptune DXP platform via the DXP Marketplace. Once imported you can use Neptune DXP’s API Designer to view the platform APIs. Each core API offers the following operations:

POST /Save

Allowing to create new entries for Neptune DXP resources, such as a database table.

POST /List

Fetching all existing entries for a Neptune DXP resource, such as the list of APIs endpoints.

POST /Get

Fetching an individual Neptune DXP resource.

POST /Delete

Removing an individual Neptune DXP resource.

After a core APIs is installed for a Neptune DXP application server or microservice it can be invoked:

  • Internally within the Neptune DXP workload, for example. to automate tasks

  • By an external system after it has onboarded the Core API of the Neptune DXP workload

The latter gives rise to wider automation capabilities. Consider for example the provisioning of microservices in containerised. As a starting point, you may have configured a Docker image where you successfully have pre-configured a range of settings for your Neptune DXP workload. However, other settings may only be possible to configure after the microservice is stood up and in operation. You can then implement an external microservice responsible for the injection of additional settings before it is made available for operational use:

dxp platform admin

In the example above, the core API of each Neptune DXP application server or microservice is exposed to a centralised directory microservice controlling the injection of dynamically generated configuration setting at runtime, for example, the location of a database service or customised access level control settings.