ApimaticLogaltySDK 0.0.2

Getting Started with Logalty Certificate Issuance API (Certy)

Introduction

API for certificate issuance through Logalty's "Certy" service.

Authentication

This API uses OAuth2 client credentials flow. A pair of keys (client_id / client_secret) per environment must be requested from the Logalty integration team at integration@logalty.com.

Flow overview

1. Authenticate against the OAuth2 server to obtain a Bearer token.
2. Create a certificate issuance transaction.
3. Query the transaction status.
4. Download evidences (images, video, OCR) when available.
5. Perform operations (resend access, cancel) if needed.
6. Receive event notifications via the Feedback webhook.

Install the Package

If you are building with .NET CLI tools then you can also use the following command:

dotnet add package ApimaticLogaltySDK --version 0.0.2

You can also view the package at: https://www.nuget.org/packages/ApimaticLogaltySDK/0.0.2

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

The API client can be initialized as follows:

Code-Based Initialization

using LogaltyCertificateIssuanceApiCerty.Standard;
using LogaltyCertificateIssuanceApiCerty.Standard.Authentication;
using Microsoft.Extensions.Logging;

namespace ConsoleApp;

LogaltyCertificateIssuanceApiCertyClient client = new LogaltyCertificateIssuanceApiCertyClient.Builder()
    .BearerAuthCredentials(
        new BearerAuthModel.Builder(
            "AccessToken"
        )
        .Build())
    .BasicAuthCredentials(
        new BasicAuthModel.Builder(
            "Username",
            "Password"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .Environment(LogaltyCertificateIssuanceApiCerty.Standard.Environment.Production)
    .CertyServer("certy_server")
    .Oauth2Server("oauth2_server")
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using LogaltyCertificateIssuanceApiCerty.Standard;
using Microsoft.Extensions.Configuration;

namespace ConsoleApp;

// Build the IConfiguration using .NET conventions (JSON, environment, etc.)
var configuration = new ConfigurationBuilder()
    .AddJsonFile("config.json")
    .AddEnvironmentVariables() // [optional] read environment variables
    .Build();

// Instantiate your SDK and configure it from IConfiguration
var client = LogaltyCertificateIssuanceApiCertyClient
    .FromConfiguration(configuration.GetSection("LogaltyCertificateIssuanceApiCerty"));

See the Configuration-Based Initialization section for details.

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Authorization

This API uses the following authentication schemes.

• bearerAuth (OAuth 2 Bearer token)
• basicAuth (Basic Authentication)

List of APIs

• Certificate Requests
• Authentication
• Evidence
• Operations

SDK Infrastructure

Configuration

• Configuration-Based Initialization
• HttpClientConfiguration
• HttpClientConfigurationBuilder
• LogBuilder
• LogRequestBuilder
• LogResponseBuilder
• ProxyConfigurationBuilder

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper