Usage

Installation of the service, basic methods and examples of their use.

Prerequisites: In order to be able to use the SDK, the following steps have to be done:

• Register an account at developer.aura.com

• Create a project and use a name for your project as a Public key. Private key is optional.

• Use SDK where carrierId equals given Public Key and baseUrl equals URL from the project details.

Configuration: Install UnifiedSDK service - it is a self-contained application, so there is no need to install a runtime:

For install UnifiedSDK service use:

UnifiedSDK.Service.exe -INSTALL "ServiceName"

For uninstall:

UnifiedSDK.Service.exe -UNINSTALL "ServiceName"

Add "UnifiedSDK.Core.dll"/"UnifiedSDK.Core.net452.dll" to your project.Initialization

InitializeAsync

Sends initialization request to UnifiedSdkService with start parameters like: backend URI, netfilter driver name and MessageFormat for conversation between SDK and UnifiedSdkService (XML, JSON). Must be called before any other SDK methods.

C#:
    var sdk = new SDK();
    var result = await sdk.InitializeAsync(BASEURI, NETFILTERDRIVERNAME, MessageFormat.JSON).ConfigureAwait(false);
    Console.WriteLine(result.Result);
C++:
    auto sdk = gcnew SDK();
    auto initResponse = sdk->Initialize(backendUrl, netfilterName, MessageFormat::JSON);

Authentication

Aura Partner VPN Backend supports OAuth authentication with a partner`s OAuth server, this is a primary authentication method.

Steps to implement OAuth

• Deploy and configure OAuth service. Service should be publicly available on the Internet.

• Configure Partner Backend to use OAuth service.

• Implement client OAuth for your application

• Retrieve access token in client app, this token will be used to initialize and sign in to Android Partner

Authentication method types

• AuthenticationMethod.Anonymous;

• AuthenticationMethod.OAuth

• AuthenticationMethod.Firebase

• Custom

Login implementation example

                var loginResponse = await this.sdk.LoginAsync(carrierId, deviceId, Environment.MachineName, AuthenticationMethod.Firebase, token).ConfigureAwait(false);
                if (loginResponse.Result != ResponseResult.Ok)
                {
                    logger.Error($"Login: {loginResponse.Result} - {loginResponse.Message}");
                    return;
                }