Getting Started with Composer APIs

The Conga Composer API uses the following features for security:

Uses SSL (HTTPS) to ensure all data is secure. Calls made over plain HTTP will fail.
Uses API Key to validate API users. API requests without authentication will fail.

Configuring Composer API Settings

To use Conga Composer API, you must first generate your Client ID and your Client Secret.

Login to the Conga Platform.
Navigate to Org Management > Conga API Connections.
Click the Add API to API Connection button.
Select External Identifier.
Click Save and Generate Client Secret.

Authentication

At Conga, we value the security of our customers’ data more than anything else. Authenticating for Composer REST APIs requires a Client ID and Client Secret to connect your API solution to Conga Composer API.

Generate Conga Authentication Access Token

The Auth Access Token API call returns the Conga-access-token, which will be used to authorize the API call.

HTTP Method: POST
Endpoint: https://login-rls.congacloud.com/api/v1/auth/connect/token
Required Headers: Content-Type: application/x-www-form-urlencoded

Post Body:


grant_type	‘client_credentials’
Scope	‘doc-gen.composer’
client_id	<<Client ID provided after onboarding>>
client_secret	<<Client Secret provided after onboarding>>

Sample Response:

{
    "access_token": "eyJh………… ",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "doc-gen.composer"
}

Endpoints

Composer Platform APIs use the following as their production environment endpoints:

NA Environments

Auth endpoint: https://login-rls.congacloud.com/api/v1/auth/connect/token
Merge endpoint: https://coreapps-rlsprod.congacloud.com/api/ingress/v1/Merge
Status endpoint: https://coreapps-rlsprod.congacloud.com/api/ingress/v1/status/{{CORRELATION_ID}}
Endpoint for Download Service API: https://coreapps- rlsprod.congacloud.com/api/presigned/v1/PreSignedService/{CorrelationId}

EU Environments

Auth endpoint: https://login.congacloud.eu/api/v1/auth/connect/token
Merge endpoint: https://coreapps.congacloud.eu/api/ingress/v1/Merge
Status endpoint: https://coreapps.congacloud.eu/api/ingress/v1/status/{{CORRELATION_ID}}
Endpoint for Download Service API: https://coreapps.congacloud.eu/api/presigned/v1/PreSignedService/{CorrelationId}

AP Environments

Auth endpoint: https://login.congacloud.au/api/v1/auth/connect/token
Merge endpoint: https://coreapps.congacloud.au/api/ingress/v1/Merge
Status endpoint: https://coreapps.congacloud.au/api/ingress/v1/status/{{CORRELATION_ID}}
Endpoint for Download Service API: https://coreapps.congacloud.au/api/presigned/v1/PreSignedService/{CorrelationId}

Preview Environment Endpoints

NA Environments

New Auth endpoint: https://login-rlspreview.congacloud.com/api/v1/auth/connect/token
New Merge endpoint: https://coreapps-rlspreview.congacloud.com/api/ingress/v1/Merge
New Status endpoint: https://coreapps-rlspreview.congacloud.com/api/ingress/v1/status/{{CORRELATION_ID}}
New Download endpoint: https://coreapps-rlspreview.congacloud.com/api/presigned/v1/PreSignedService/{CorrelationId}

EU Environments

New Auth endpoint: https://login-preview.congacloud.eu/api/v1/auth/connect/token
New Merge endpoint: https://coreapps-preview.congacloud.eu/api/ingress/v1/Merge
New Status endpoint: https://coreapps-preview.congacloud.eu/api/ingress/v1/status/{{CORRELATION_ID}}
New Download endpoint: https://coreapps-preview.congacloud.eu/api/presigned/v1/PreSignedService/{CorrelationId}

AP Environments

New Auth endpoint: https://login-preview.congacloud.au/api/v1/auth/connect/token
New Merge endpoint: https://coreapps-preview.congacloud.au/api/ingress/v1/Merge
New Status endpoint: https://coreapps-preview.congacloud.au/api/ingress/v1/status/{{CORRELATION_ID}}
New Download endpoint: https://coreapps-preview.congacloud.au/api/presigned/v1/PreSignedService/{CorrelationId}

Errors

Conga Composer uses standard HTTP response codes to indicate the success or failure of an API request. Below are some example response codes:


Code	Description
200	Successful Operation
204	No Content
400	Invalid Data
401	Unauthorized
422	Validation Error
500	Internal Server Error

Note:

Important

The Composer APIs are available as part of an early adopter program that requires Conga product management review for inclusion.

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.