DigitechSystems/Systm.AppServicesv5.8.25314.12103
✓ Verified.NET FW4.7.2.NET Std2.0
A Sys.tm® package for authentication and utilizing the Sys.tm API.
Get Started
$ dotnet add package Systm.AppServicesReadme
Systm.AppServices
The Systm.AppServices library provides a robust framework for managing sessions, tokens, and various system-level operations in applications. It is designed to work with .NET Standard 2.0 and .NET Framework 4.7.2, ensuring compatibility across a wide range of platforms.
Features
- Session Management: Create, retrieve, and manage sessions with support for multiple organizations.
- Token Management: Refresh and manage authentication tokens seamlessly.
- API Calls: You can make any of the Sys.tm® API calls by using the SystmManager.MakeApiCall() method.
Installation
Install the package via NuGet Package Manager:
Install-Package Systm.AppServices
Or via the .NET CLI:
dotnet add package Systm.AppServices
Usage
1. Initialize SystmManager
The SystmManager class is the entry point for managing sessions, tokens, and making API calls.
Note: Before utilizing the Sys.tm API, you will need to be issued an API key by contacting support@sys.tm.
using SYSTM.AppServices;
using SYSTM.AppServices.Models;
var sysConfig = new SysConfig
{
ApiKey = "My_Systm_API_Key"
};
SystmManager systmManager = new SystmManager(sysConfig, null);
2. Authorize a Device
//This ID is for the Sys.tm External API App Client and cannot be changed
string clientId = "10j898a433qi77projmk4bc7r7";
string deviceName = "YourDeviceName";
var sysConfig = await SystmManager.GetDefaultSysConfig();
sysConfig.ApiKey = "My_Systm_API_Key";
SystmManager systmManager = new SystmManager(sysConfig, null);
var initialResponse = await systmManager.TokenService.DeviceAuth_Start(clientId, deviceName);
if (!initialResponse.IsSuccess)
{
throw new Exception(initialResponse.Error);
}
//Use the default browser to show the Sys.tm authentication page
System.Diagnostics.Process.Start(initialResponse.verification_uri_complete);
CancellationTokenSource source = new CancellationTokenSource();
systmManager.SystmCredentials = await systmManager.TokenService.WaitForDeviceAuth(clientId, initialResponse, source.Token);
3. Retrieve Organizations
var organizationsResult = await systmManager.GetOrganizations();
if (organizationsResult.IsSuccess)
{
foreach (var org in organizationsResult.Organizations)
{
Console.WriteLine($"Organization: {org.Name} (ID: {org.Id})");
}
}
else
{
Console.WriteLine($"Failed to retrieve organizations: {organizationsResult.Message}");
}
4. Manage Sessions
Initialize a New Session
var initResult = await systmManager.InitSession("organizationId123");
if (initResult.CreatedSession)
{
Console.WriteLine("Session created successfully.");
}
else
{
Console.WriteLine($"Failed to create session: {initResult.Message}");
}
Get an Existing Session
var session = await systmManager.GetSession("entityId123");
Console.WriteLine($"Session ID: {session.Id}");
5. Refresh Credentials
await systmManager.RefreshSystmCredentials();
Console.WriteLine("Credentials refreshed successfully.");
6. Make API Calls
Make a call with query string parameters
var accessToken = @"Access_Token_From_Systm_Device_Authorization";
var refreshToken = @"Refresh_Token_From_Systm_Device_Authorization";
string orgId = "Organization_ID_From_GetOrganizations_Call";
string fileId = "My_File_ID";
var sysConfig = await SystmManager.GetDefaultSysConfig();
sysConfig.ApiKey = "My_Systm_API_Key";
SystmManager systmManager = new SystmManager(sysConfig, null);
systmManager.SystmCredentials = await systmManager.TokenService.GetCredentialsFromJwtAuth(accessToken, refreshToken);
await systmManager.InitSession(orgId);
NameValueCollection queryStringParams = new NameValueCollection() { { "Id", fileId } };
ApiResponse response = await systmManager.MakeApiCall("files", Method.GET, queryStringParams, string.Empty);
string s3Key = response.JsonResult.GetProperty("S3Key").GetString();
Make a call with JSON body
var accessToken = @"Access_Token_From_Systm_Device_Authorization";
var refreshToken = @"Refresh_Token_From_Systm_Device_Authorization";
string body = "{\"ContentModified\":\"1997-07-25T14:07:49.0156138-06:00\", \"PageSizeLimit\":100}";
var sysConfig = await SystmManager.GetDefaultSysConfig();
sysConfig.ApiKey = "My_Systm_API_Key";
SystmManager systmManager = new SystmManager(sysConfig, null);
systmManager.SystmCredentials = await systmManager.TokenService.GetCredentialsFromJwtAuth(accessToken, refreshToken);
await systmManager.InitSession(orgId);
ApiResponse response = await systmManager.MakeApiCall("folders/contents/modified", Method.POST, null, body);
var folders = response.JsonResult.GetProperty("Folders");
var firstFolder = folders[0];
string firstModifiedFolderName = firstFolder.GetProperty("Name").GetString();
Dependencies
This library depends on the following NuGet packages:
System.Text.JsonMicrosoft.AspNetCore.StaticFilesAWSSDK.CoreAWSSDK.CognitoIdentityAWSSDK.CognitoIdentityProviderAWSSDK.S3
Target Frameworks
.NET Standard 2.0.NET Framework 4.7.2
License
This library is licensed under the Digitech Systems, LLC end user license agreement.