Certiverse Test Driver Integration

Launch Certiverse exams from 3rd party applications.

Overview

Giving third parties the ability to utilize Certiverse as their test driver for test delivery

Version Information

Version: 1.3

URI Scheme

Base Path: /api

Scheme: HTTPS

Paths

Summary

Authenticate as a Certiverse partner to gain an authentication token for calls needing to be executed.

Headers

Query Parameters

Responses

Models

PartnerDataTokensModel (ContentType: application/json)

ErrorModel (ContentType: application/json)

Summary

Validate information and prepare an exam to be proctored by a third party returning an encrypted launch url

Headers

Parameters

Responses

Commands

ProvisioningCommand

Contains information required to provision an exam for a Candidate. 

CandidateCommand

Candidate’s basic information 

ReservationCommand

Candidate’s reservation details like booking related information. 

ExamCommand

Candidate’s exam related information. 

Models

ProvisioningModel (ContentType: application/json)

Contains launch url. 

Summary

Validate information and stop an exam currently proctored by a third party

Headers

Parameters

PartnerExamStopCommand (ContentType: application/json)

*Note: Properties here are taken from the ProvisiongCommand used during the Provision call. 

C# Code Samples:

Authenticate

private const string FunctionKey = "";
private const string ClientId = "";
private const string ClientSecret = "";
private const string Endpoint = "https://partner.certiverse.com/api/authenticate";
    
public static string GetJwt()
{
    using (HttpClient httpClient = new HttpClient())
    {
        string callingCode = System.Guid.NewGuid().ToString();
        using (HttpRequestMessage request = new HttpRequestMessage(new HttpMethod("GET"), $"{Endpoint}?code={callingCode}"))
        {
            // Set the Function Key header
            request.Headers.TryAddWithoutValidation("x-functions-key", FunctionKey);

            // Set the Authorization Header
            // Get Base64 Encoded String
            byte[] plainTextBytes = System.Text.Encoding.UTF8.GetBytes($"{ClientId}:{ClientSecret}");
            string encodedConsumerCredentials = System.Convert.ToBase64String(plainTextBytes);
            request.Headers.TryAddWithoutValidation("Authorization", $"Basic {encodedConsumerCredentials}");

            try
            {
                // Make the call
                HttpResponseMessage response = httpClient.Send(request);

                // Handle the response
                if (response.IsSuccessStatusCode)
                {
                    using (HttpContent responseContent = response.Content)
                    {
                        string successResponse = responseContent.ReadAsStringAsync().Result;
                        ResponseModel responseModel = JsonSerializer.Deserialize<ResponseModel>(successResponse);

                        if (responseModel == null)
                        {
                            throw new System.Exception("Unable to deserialize response");
                        }

                        // Optional: If passed in a code, validate code is returned
                        if (!string.Equals(responseModel.Code, callingCode))
                        {
                            // Handle code being intercepted
                            throw new System.Exception("Calling Code Mismatch");
                        }

                        return responseModel.BearerToken;
                    }
                }
                else
                {
                    // Handle non-success response
                    throw new System.Exception($"Invalid response: {response.StatusCode}");
                }
            }
            catch (System.Exception ex)
            {
                // Handle Exception
                throw;
            }
        }
    }
}

Provision Call

 private const string BearerToken = ""; //retrieved from previous call
private const string Endpoint = "https://partner.certiverse.com/api/provision";

private string GetLaunchUrl()
{

    using (HttpClient httpClient = new HttpClient())
    {
        using (HttpRequestMessage request = new HttpRequestMessage(new HttpMethod("POST"), Endpoint))
        {
            // Set the Authorization Header
            request.Headers.TryAddWithoutValidation("Authorization", $"Bearer {BearerToken}");

            // Set the body of the call
            // Define the request object
            ProvisionRequest provisionRequest = new ProvisionRequest
            {
                Candidate = new ProvisionCandidate
                {
                    CandidateId = "",
                    Country = "",
                    Email = "",
                    FirstName = "",
                    LastName = ""
                },

                Reservation = new ProvisionReservation
                {
                    BookingCode = "",
                    EligibilityId = "",
                },

                Exam = new ProvisionExam
                {
                    ExamCode = "",
                    Language = "",
                    ReturnUrl = null, // null or valid URL. Empty is not accepted
                    AdditionalTime = null
                }
            };
            string provisionRequestBody = JsonSerializer.Serialize(provisionRequest);
            request.Content = new StringContent(provisionRequestBody, Encoding.UTF8, "application/json");

            try
            {
                // Make the call
                HttpResponseMessage response = httpClient.Send(request);

                // Handle the response
                if (response.IsSuccessStatusCode)
                {
                    using (HttpContent responseContent = response.Content)
                    {
                        string successResponse = responseContent.ReadAsStringAsync().Result;
                        ResponseModel responseModel = JsonSerializer.Deserialize<ResponseModel>(successResponse);

                        if (responseModel == null)
                            throw new System.Exception("Unable to deserialize response");

                        return responseModel.EncryptedLaunchUrl;
                    }
                }
                else
                {
                    // Handle non-success response
                    throw new System.Exception($"Invalid response: {response.StatusCode}");
                }
            }
            catch (Exception ex)
            {
                // Handle Exception
                throw;
            }
        }
    }
}

 private const string BearerToken = "";
private const string Endpoint = "https://partner.certiverse.com/api/exam/stop";

private void StopExam()
{
    using (HttpClient httpClient = new HttpClient())
    {
        using (HttpRequestMessage request = new HttpRequestMessage(new HttpMethod("POST"), Endpoint))
        {
            // Set the Authorization Header
            request.Headers.TryAddWithoutValidation("Authorization", $"Bearer {BearerToken}");

            // Set the body of the call
            // Define the request object
            ExamStopRequest provisionRequest = new ExamStopRequest
            {
                BookingCode = "",
                CandidateId = "",
                Email = ""
            };
            string provisionRequestBody = JsonSerializer.Serialize(provisionRequest);
            request.Content = new StringContent(provisionRequestBody, Encoding.UTF8, "application/json");

            try
            {
                // Make the call
                HttpResponseMessage response = httpClient.Send(request);

                // Handle the response
                if (!response.IsSuccessStatusCode)
                    throw new System.Exception($"Unable to Stop Exam. Response: {response.StatusCode}");
            }
            catch (Exception ex)
            {
                // Handle Exception
                throw;
            }
        }
    }
}