Define the HTML and authentication parameters
A valid access to the RESTful services of the third-party components is granted and the required configuration parameters are available for the configuration. Alfabet 's generic API integration interface supports HTTP, OAuth and OAuth2 authentication.
The configuration is done in Alfabet Expand in the XML element GenericAPIIntegrationConfig.
To access the XML element, click the Presentation tab and expand the explorer nodes XML Objects > Integration Solutions. Double click the GenericAPIIntegrationConfig node to open the XML definition.
The XML definition of a connection to a third-party component consists of three parts: the authentication definition, the connection definition, and an optional proxy definition.
You can define connection parameters for multiple third-party components. Each part of the definition is therefore wrapped in a header element.
- <GenericAPIIntegrationConfig>
- <Proxy url="" user="" password="" domain="">
- <AdditionalProxies>
- <AdditionalProxy Name="" url="" user="" password="" domain="" />
- </AdditionalProxies>
- <AdditionalProxies>
- </Proxy>
- <Authentications>
- <Authentication Name="DevOpsCloudOApp" Type="OAuth2" Flow="AuthorizationCode" ClientId="" Scope="" ClientSecret="" CallBackURL="" AuthCode="">
- <Authorization Url="https://app.vssps.visualstudio.com/oauth2/authorize">
- <RequestParameters>
- <Parameter Name="client_id" Value="{ClientId}"/>
- <Parameter Name="response_type" Value="Assertion"/>
- <Parameter Name="state" Value="{State}"/>
- <Parameter Name="scope" Value="{Scope}"/>
- <Parameter Name="callbackURL" Value="{CallBackURL}"/>
- </RequestParameters>
- <RequestParameters>
- </Authorization>
- <TokenRequest Url="https://app.vssps.visualstudio.com/oauth2/token">
- <RequestParameters>
- <Parameter Name="client_assertion_type" Value="urn:ietf:params:oauth:client-assertion-type:jwt-bearer"/>
- <Parameter Name="client_assertion" Value="{ClientSecret}"/>
- <Parameter Name="grant_type" Value="urn:ietf:params:oauth:grant-type:jwt-bearer"/>
- <Parameter Name="assertion" Value="{AuthCode}"/>
- <Parameter Name="redirect_uri" Value="{CallBackURL}"/>
- </RequestParameters>
- <RequestParameters>
- </TokenRequest>
- <RefreshTokenRequest Url="https://app.vssps.visualstudio.com/oauth2/token">
- <RequestParameters>
- <Parameter Name="client_assertion_type" Value="urn:ietf:params:oauth:client-assertion-type:jwt-bearer"/>
- <Parameter Name="client_assertion" Value="{ClientSecret}"/>
- <Parameter Name="grant_type" Value="refresh_token"/>
- <Parameter Name="assertion" Value="{RefreshToken}"/>
- <Parameter Name="redirect_uri" Value="{CallBackURL}"/>
- </RequestParameters>
- <RequestParameters>
- </RefreshTokenRequest>
- <Authorization Url="https://app.vssps.visualstudio.com/oauth2/authorize">
- </Authentication>
- <Authentication Name="DevOpsCloudOApp" Type="OAuth2" Flow="AuthorizationCode" ClientId="" Scope="" ClientSecret="" CallBackURL="" AuthCode="">
- </Authentications>
- <GenericAPIIntegrationConnections>
- <GenericAPIIntegrationConnection Name="Onpremise1" InstanceURL="https://dev.azure.com" Proxy="None" Authentication="DevOpsCloudOApp" Timeout="60">
- </GenericAPIIntegrationConnection>
- </GenericAPIIntegrationConnections>
- <Proxy url="" user="" password="" domain="">
- </GenericAPIIntegrationConfig>
You must define both an authentication definition and a connection definition.