Public API: Example start of test

To give a more practical example of the start test API call we have created an example powershell script that is part of every Login Enterprise release from 4.1 and higher. When you have created an Application Testing test scenario you can find this information at the top of the window.

Once clicked on the button you are shown a window that has two links, one is the link to the public API of your appliance and the other is linked to a download of the example PS1 file. If you do not have access to a Login Enterprise appliance you can view the Public API here and can download the PS1 file attached in this article, download is at the bottom of the article.

When the script is downloaded from your own appliance it will be pre-configured for the environment and Login Enterprise appliance. If you download it from our article you need to configure the following three(3) values:

# basic information
[string]$publicApiSecret = 'b99a18bf690c7a8b23713646df2292f5991086e2'
[string]$baseUrl = 'https://MyLoginEnterpriseAppliance.co.uk/publicApi'

# Guid that identifies the Environment.
$environmentId = '8ff2053b-b1ba-4b84-aa81-10a6ba2e856f'

The publicAPISecret can be found in the "Login Enterprise > External Notifications > Public API" under "ControlPublicApi". 

The BaseURL is ofcourse your own Login Enterprise URL on which you connect to. 

The EnvironmentID can be fetched when you have openend an environment from the URL bar of your browser.

Example Script

The script itself is is fairly simple we have outlined the script below. What it does is it will setup a secure connection based on your configurations if possible and will ignore SSL erros by default. It will then configure the token for authentication. Once that is done it will send the API request to start the specified test!

# basic information
[string]$publicApiSecret = 'b99a18bf690c7a8b23713646df2292f5991086e2'
[string]$baseUrl = 'https://MyLoginEnterpriseAppliance.co.uk/publicApi'

# Guid that identifies the Environment.
$environmentId = '8ff2053b-b1ba-4b84-aa81-10a6ba2e856f'
# Additional information required to start the test.
$requestObject = @{
 # Comment
 'comment' = '...'
}

# if something goes wrong (e.g. authentication) we stop processing this script
$ErrorActionPreference = 'Stop'

# this is only required for older version of PowerShell/.NET
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 -bor [Net.SecurityProtocolType]::Tls11


# WARNING: ignoring SSL/TLS certificate errors is a security risk
[System.Net.ServicePointManager]::ServerCertificateValidationCallback = { return $true; }

$requestHeaders = @{ 'Content-Type' = 'application/json' }

# acquire an access token from the authentication endpoint
$authRequest = ConvertTo-Json -InputObject @{ secret = $publicApiSecret }
$authResponse = Invoke-RestMethod -Method Post -Uri "${baseUrl}/v2/authentication/token" -Headers $requestHeaders -Body $authRequest

# add the authorization http header for all subsequent requests
$requestHeaders.Add('Authorization', "Bearer $($authResponse.accessToken)")

$requestBody = ConvertTo-Json -InputObject $requestObject
try {
 $response = Invoke-RestMethod -Method Put -Uri "${baseUrl}/v2/environments/${environmentId}/start" -Headers $requestHeaders -Body $requestBody
 Write-Host -Object 'Success'

} catch {
 [int]$statusCode = $_.Exception.Response.StatusCode;

switch ($statusCode) {
 403 { Write-Host -Object 'Forbidden' }
 404 { Write-Host -Object 'Environment not found' }
 409 { Write-Host -Object 'Unable to start test' }
 401 { Write-Host -Object 'Unauthorized' }
 default { throw }
 }
}