Russian

TotalAPI SDK .NET

Introduction

TotalAPI is a cloud service providing various API for program complexes development and SDK , which will allow to easily using these API. TotalAPI provides the developers with user-friendly framework which lowers labor inputs and risks during routine tasks development which are faced within distributed business applications. For instance, management of messages exchange among program systems, access to business objects and organization of program modules interfaces.

Installation

1. Download TotalAPI and metriX SDKs
2. Download Linq2Rest and Newtonsoft.Json. You could get the packages from Nuget.
3. Include Linq2Rest, Newtonsoft.Json and client SDK libs into your project.

Getting started

1. Register your App

Please, register your app and you will be provided with the authentication keys (ApiKey & AppKey) and the service URL.

2. Tune the SDK with intial settings

Please, define some settings in the application configuration file yourapplication.exe.config. One should define TotalAPI service URL and authentication key. Please, see about the SDK settings details here. SDK Init settings example:

    <appSettings>
    	<add key="serverHost" value="http://services.totalapi.io:1202" />
        <add key="apiKey" value="myApiKey" />
    </appSettings>

All initialization data will be provided after registration.

3. Include the SDK modules

Please, include into your project following libs:

• Linq2Rest
• Newtonsoft.Json
• TotalApi.Utils.Common
• TotalApi.Utils.IoC
• TotalApi.Utils.Wcf
• TotalApi.Core
• TotalApi.Billing.Client
• TotalApi.EventManager.Client
• TotalApi.Telematics.Api
• TotalApi.Telematics.Client

The two last libs (TotalApi.Telematics.Api and TotalApi.Telematics.Client) are required if you would like to utilise telematic funtionality of the metrixAPI.

Attention! In vast most cases you do not need to include into the project the rest of libs from here. One needs all libraries included if he/she implements a new TotalAPI service only. Otherwise your app could work improperly.

4. Start the SDK in your app

Please, invoke the SDK initialization method when your app starts:

    TotalApiBootstrapper.Create();

More detailes concerning assambles loading.

5. Do a simple query to the TotalAPI service

One can test the sevice with following request:

	// The sample of the using Repository API
	IEnumerable<Application> apps = CoreApi.Repository.ExecuteQuery<Application>();

The responce contains registration data. [Please, see more samples with TotalAPI SDK](/samples/SDK samples/Startup)

Documentation and Samples

• TotalAPI SDK settings
• [Various code samples](/samples/SDK samples)
• Telemetric sample application
• Distributed repository
• Distributed events
• Application log
• API documentation
• TotalAPI SDK functions description
• User autentification in Total API

Known issues

Please see here

License

TotalAPI SDK dstributed with MIT License