Skip to main content

API Service (idapi)

The API Service (idapi) enables client programs to access Bravura Security Fabric workflow and provisioning features programmatically. Client programs communicate with the service using:

  • SOAP (Simple Object Access Protocol)

    Some organizations use the SOAP API to build their own customized front-end to Bravura Security Fabric .

  • PSLang functions

    Bravura Security Fabric plugins can use PSLang to retrieve additional information about users, resources, and requests from the API Service.

Refer to the Bravura Security Fabric Remote API (api.pdf) to learn about the Bravura Security Fabric API, and how to install and use the SOAP API. Refer to the PSLang Manual (pslang.pdf) for more information about PSLang.

Dependencies / requirements

The API Service is dependent on the Database Service . If you restart the database service, you must restart the API Service.

Configuration

The service is automatically installed and started on the Bravura Security Fabric server during setup.

You can modify the following parameters related to the API Service on the Service information page:

Table 1. idapi service options

Option

Description

Timeout for connection in seconds

The timeout to use for connections. The default is 60 seconds.



Command-line options for idapi are listed below:

Table 2. idapi service command-line options

Argument

Description

-h

Displays usage information.

-v

Displays version number only.

-config

Displays service configuration information.

-server

Run the service in server mode.

-start

Starts the service.

-stop

Stops the server/service