API Base URL

The API Base URL Settings option allows administrators and users to configure and view the base URLs for APIs. These base URLs can then be shared across teams for calling API services without requiring frequent DevOps intervention.

By using the API Base URL Settings, end users can easily obtain the full URL of any published Data-as-API service in a standardized format.

Access API Base URL Settings

1. Navigate to the Admin Panel.

2. Click API Base URL Configuration.

   • The API Base URL page opens.

   • The page displays the configured base URL set by the DevOps team.

   • Example: app.bdb.ai/services is displayed as the configured base URL.

Use API Base URL in Client Registration

1. Navigate to the API Client Registration option.

2. Click the Edit icon for a registered client.

   • The API Client Registration details page opens.

3. Click the Document link displayed on the registration page.

   • This link redirects to a documentation page showing the API URL along with additional service details required to call the API service.

API Base URL with Service Name

• The final API endpoint is a combination of the API Base URL and the Service Name.

• This combined URL can be safely shared across teams for consistent API access.

Note

• The Base URL is configured and maintained by the DevOps team.

• End users only need to reference the combined URL (Base URL + Service Name) when consuming APIs.