Skip to content

Latest commit

 

History

History
84 lines (69 loc) · 5.58 KB

README.md

File metadata and controls

84 lines (69 loc) · 5.58 KB

English

TotalAPI SDK .NET

Введение

TotalAPI это Cloud API решение нового поколения для разработки распределённых масштабируемых модульных программных комплексов. TotalAPI представляет собой облачную службу предоставляющую различные API для разработки программных комплексов, а также SDK который позволит легко использовать эти API. TotalAPI предоставляет разработчикам удобный фреймворк, снижающий трудозатраты и риски при разработке рутинных задач, встречающихся в распределенных бизнес приложениях. Например, организация обмена сообщениями между программными системами, организация доступа к бизнес объектам и интерфейсам программных модулей.

Инсталляция

  1. Скачайте TotalAPI и metriX SDKs
  2. Скачайте также Linq2Rest и Newtonsoft.Json. Оба пакета доступны через Nuget.
  3. Включите Linq2Rest, Newtonsoft.Json и клиентские библиотеки SDK в ваш проект

Как начать использовать SDK

1. Регистрация

Зарегистрируйте свое приложение и получите ключи ApiKey и AppKey для аутентификации ваших запросов а также адрес для подключения к сервису TotalAPI.

2. Инициализация SDK

Выполните инициализацию SDK в файле yourapplication.exe.config. Укажите адрес подключения к сервису TotalAPI и ключи аутентификации. Подробнее о настройках SDK

    <appSettings>
    	<add key="serverProtocol" value="https" />
    	<add key="serverHost" value="svc.totalapi.io:4444" />
        <add key="apiKey" value="myApiKey" />
    </appSettings>

Необходимые значения вы получите при регистрации.

3. Подключение модулей SDK

Для использования TotalApi SDK в клиентском приложении необходимо наличие следующих библиотек:

  • 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

Последние две библиотеки необходимы, если вы собираетесь использовать телематическую часть подсистемы metrixApi.

При написании клиентского приложения не включайте в проект другие библиотеки из полного состава. В противном случае возможна некорректная работа приложения.

При старте приложения следует вызвать метод инициализации клиентского SDK:

    TotalApiBootstrapper.Create();

Подробнее о загрузке сборок.

4. Выполнение запроса к сервису TotalAPI

Ниже пример запроса на получение информации о зарегистрированном приложении.

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

[Пример простейшего приложения с TotalAPI SDK](../../samples/SDK samples/Startup)

Документация и примеры

Известные проблемы и предложения

Известные проблемы и предложения

Лицензия

TotalAPI SDK распостраняется по лицензии MIT