The Web API uses OAuth2.0 & OpenId connect as its authentication protocol. The Congree Identity Server acts as the authentication server. It supports password and Trust CMS authorization.

In order to use the Congree REST API, the client has to use the following OAuth parameters:

OAuth parameter	Value
client_id	CongreeWebAPI
scope	webApi termTigerWebAppApi

The authorization endpoint is located at http://<WebAPIHost>/congreeidentityserver. The scope 'termTigerWebAppApi' is only important if you plan to use the CongreeTermTiger API:

POST

/congreeidentityserver/connect/token

OAuth2.0

Congree password authorization

This authorization method can be used for logging in to Congree using Congree user credentials. The OAuth parameters should be the following:

OAuth parameter

Value

grant_type

password

username

password

*If password is empty use ''

Trust CMS authorization

This authorization method can be used for logging in to Congree using Trust CMS. The OAuth parameters should be the following:

OAuth parameter	Value	Comment
grant_type	password
congree_auth_type	trustcms	Additional parameter. Not used by classic OAuth2.0
username	<Trust CMS user name>
password	<TrustCMSSecret>

For Trust CMS to work, you need to store a password encrypted with base64 in C:\Program Files\Congree Language Technologies GmbH\Congree Identity Server\appsettings.json and to use it in your token request (in plain text form).

{
  "Logging": {
    "LogLevel": {
      "Default": "Warning"
    }
  },
  "AllowedHosts": "*",
  "Congree": {
    "TrustCMSSecret": "YW55MTIz"
  }
}

Support third-party identifiers

The Identity server supports third-party systems, which are configured in the Congree Control Center. For now, only identifiers for the Congree Bulk Check Service are supported. To work with third-party identifiers, you should use the following additional parameter:

OAuth parameter	Value
third_party_identifier	<identifier for Congree Bulk Check Service>

Third-party systems support all authorization methods. If the specified parameter is not used, default Congree Bulk Check Service settings will be used.

Browser nicht unterstützt