Content Comparison

The gateway Connexion service includes an API which allows you to programmatically provision remote agents (and channels, packages, etc.)modify the Connexion configuration. This API is subject to change as Connexion functionality is updated.

To enable the gateway Connexion api service, run the Gateway configuration wizard and enable check the 'Enable the Connexion API' checkbox. Optionally change the API port (cannot be the same port as other gateway Connexion services):

...

In order to provide authentication (and TLS traffic encryption), each client which will access this API must provide a certificate. This certificate must be installed within the “Trusted People” folder of the gateway Connexion host machine.

The recommended approach is to create a unique self-signed certificate for each distinct API client. See https://docs.microsoft.com/en-us/powershell/module/pkiclient/new-selfsignedcertificate for information on creating self-signed certificates in Windows. We recommend setting the subject name of the certificate to a value which can identify the consumer (user name, machine name, etc.).

...

...

Image Added

Once you have run the Powershell command, you will find the new certificate in your Personal folder of the Local machine store.

...

Export this certificate to a file using the default export settings (do not include the private key). Copy this twice - once without the private key, and once with the private key. When exporting with the private key, you will need to supply a password. Copy the no-private-key file over to the gateway Connexion host and install it into the “Trusted People” store of the Local Computer. This can be achieved by right clicking the certificate file (on the gateway Connexion host) and choosing the “install certificate” option.

...

You have now completed the requirements for the client API to create a tunnel with the API service. Verify that the certificate installed correctly on the Gateway Connexion host by looking in the ‘Trusted People’ store.

...

Deleting an API client certificate from this store will revoke access to the gateway Connexion API.

Next, reference the C# client Connexion.Api library (Connexion.Gateway.Api.dll, both framework and core assemblies are available) and create a proxy to the gateway. You will need the System.ServiceModel.Primitives and System.ServiceModel.Http packages if you’re targeting .NET core.Connexion.

using System;
using System.Security.Cryptography.X509Certificates;
using Connexion.Gateway.Api;

namespace GatewayApiClientTestCxnApiClient
{
    class Program
    {
        static async voidTask Main(string[] args)
        {
            // load the certificate to pass to the gateway api
            var certificate = new X509Certificate2(@"c:\gatewayClienttest\NickLaptop.cerapicert.pfx", "foobar");

            // create a proxy to the GWConnexion
            using (var proxy = GatewayApiProxyFactoryConnexionApiProxyFactory.CreateProxy("192127.1680.30.191", 80858089, certificate))
            {
                // test the connection
                Console.WriteLine("Query Groups...");
                var response = await proxy.ServiceMethods.Ping();.GetGroupsAndTabsAsync(new GetGroupsAndTabsRequest(true));
                foreach (var group in response.Groups)
                {
                    Console.WriteLine(group.Name);
                    foreach (var tab in group.Tabs)
                    {
                        Console.WriteLine($"-->{tab.Name}");
                    }
                }
            }

            Console.ReadLine();
        }
    }
}

At this point, you can now make API calls to create and modify non-authorized remote agents. In the future, we may enable specific updates to authorized remote agents..

Sample projects: