C# SDK

Actual Version: 0.4.0a

Introduction

This section provides documentation of the Ocugine SDK for C# (.Net Framework). You can explore and use the Ocugine services to develop Windows Forms / WPF / Universal Platform applications.

Warning: If you want to use Ocugine SDK for Unity - go to the appropriate section. This SDK provided only for .Net Framework applications.

Install SDK

To install the current version of the Ocugine SDK (C#), go to download page in the Ocugine Control Panel. After that, choose whether you want to download the SDK from the Ocugine server or from the GitHub repository. All our SDKs are available under the MIT license.

Or use this direct links:

Integrate SDK

Connecting the SDK to your Visual Studio project is quite simple. To do this, add the libraries of our C# SDK to your project using "(References)". After that you can use it in the project. However, do not forget to import the libraries in your code.

To do this, connect the library using this directives:

using Ocugine_SDK;
using Ocugine_SDK.Models;

Initialize SDK

Now that you have connected your SDK, you need to initialize it in your project. To initialize the SDK, you need to create an instance of the Ocugine object. You can read more about Ocugine object constructor on this page.

Initialize Ocugine SDK by few code lines:

// Initialize Ocugine SDK
SDK = new Ocugine(new AppSettings {
    app_id = PROJECT_ID,
    app_key = PROJECT_KEY
}, new SDKSettings {
    language = "EN",
    modules = SDKModules.All
});

Where, PROJECT_ID - your Project ID and PROJECT_KEY - client key of your project. You can find PROJECT_ID and PROJECT_KEY on project settings page.

Conclusion

In this simple way, you can integrate the Ocugine SDK for your project. Further you can study more detailed information on work with Ocugine C# SDK.