Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

Conga API Connections

The Conga API Connections tab allows you to configure and manage authentication for interacting with Conga Advantage Platform APIs. It supports two types of connections: API-to-API and UI-to-API. These connections enable secure access to Conga services based on the intended integration method.

To use Conga Advantage Platform APIs, you must create a connection within this tab to generate a Client ID and Client Secret. These credentials are required for authenticating requests and establishing trust between your external application and the Conga Advantage Platform.

API-to-API connections are typically used for backend system integrations or automated processes, while UI-to-API connections are intended for use cases that involve user-interactive flows.

Note:

To configure API connections, you can also use the API Connections APIs instead of the User Interface.

Configuring an API-to-API Connection

  • You are an administrator.

  • External integration is added that will use the Conga Advantage Platform APIs.

This task guides you through configuring an API-to-API connection in the Conga Advantage Platform. API-to-API connections are used for server-to-server communication, enabling external systems or services to authenticate and securely interact with the Conga platform without requiring user involvement. Creating this connection generates a Client ID and Client Secret, which are required to authorize API requests.
Note:

Conga recommends the Integration User flow instead of API-to-API connection. For more information on how to create an integration user and generate a Client ID and Secret, see the Adding Users.

  1. Log in to the Conga Advantage Platform as an admin user.
  2. Click the App Launcher () icon from the top-left corner, then go to Admin Console > Organization.
  3. Go to the Conga API Connections tab.
  4. Click Add API-to-API Connection.
  5. Enter values in the following fields:

    Field

    Description

    External Identifier

    Select the respective External Identifier for which you want to configure the connection. The external identifier list is populated based on the External Integration that you added. For more information, see Managing External Integrations.

    Client Name

    Enter the appropriate client name. It will help you identify the specific connection from the list view.

    Description

    Enter the appropriate description.

  6. Click Save & Generation Client Secret to generate the Client ID and Client Secret.
  7. Copy the Client ID and Client Secret.
    Note:

    Once copied, the Client Secret cannot be recovered. You must regenerate the client secret by clicking the External Identifier hyperlink on the list page > Save & Regenerate Client Secret button. After regenerating the Client Secret, you must update it in all of your connected API solutions.

The API-to-API connection is configured and activated. You can Deactivate or Reactivate any of the Conga API Connections by using the respective hyperlink under the Actions column, and Edit the configuration by clicking the External Identifier hyperlink on the list page.

Configuring a UI-to-API Connection

  • You are an administrator.

  • External integration is added that will use the Conga Advantage Platform APIs.

This task guides you through configuring a UI-to-API connection in the Conga Advantage Platform. UI-to-API connections are designed for scenarios where users interact with Conga Advantage Platform APIs through a user interface, such as a web application or browser-based client. This connection type supports authentication flows that involve user consent and redirection, enabling secure, user-authorized access to Conga Advantage Platform APIs. Creating this connection provides a Client ID required for initiating the authentication flow.

  1. Login to the Conga Advantage Platform as an Admin User.
  2. Click the App Launcher () icon from the top-left corner, then go to Admin Console > Organization.
  3. Go to the Conga API Connections tab.
  4. Click Add UI-to-API Connection.
  5. Enter values in the following fields:

    Field

    Description

    External Identifier

    Select the respective External Identifier for which you want to configure the connection. The external identifier list is populated based on the External Integration that you added. For more information, see Managing External Integrations.

    Client Name

    Enter the client name.

    Description

    Enter the appropriate description.

    Redirect URI

    Enter the UI Callback Endpoint. It is the site to which identification and access tokens are sent.

    Note:

    You can also include comma-separated fully qualified multiple URLs if required.

    Cors Origins

    Enter the Domain Name present in the callback endpoint. It is the base URL of the origin server to enable cross site request.

    Back Channel Logout URI

    The back-channel specification for server-side clients (e.g. MVC).

    Front Channel Logout URI

    As part of the signout process, ensure that client applications are notified that the user has signed out. The Identity Server supports the front-channel specification for server-side clients (e.g. MVC).

  6. Click Save & Generation Client ID to generate the Client ID.
  7. Copy the Client ID.

The UI-to-API connection is configured and activated. You can Deactivate or Reactivate any of the Conga API Connections by using the respective hyperlink under the Actions column, and Edit the configuration by clicking the External Identifier hyperlink on the list page.