ScApimaticSDK 0.0.1

Getting Started with Socure RiskOS™ API

Introduction

RiskOS™ documentation site is Socure confidential and proprietary information, and is only intended for viewing by authorized persons.

The Socure RiskOS™ APIs provide a unified API framework for risk evaluation. They use predictable, resource-oriented URLs, accept JSON-formatted request bodies, return JSON-formatted responses, and follow standard HTTP methods, status codes, and authentication practices.

You can test RiskOS™ APIs in the Sandbox environment, which allows you to simulate requests without impacting live data. The request endpoint determines whether the request is directed to the Sandbox or Production (live) environment.

Install the Package

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

dotnet add package ScApimaticSDK --version 0.0.1

You can also view the package at: https://www.nuget.org/packages/ScApimaticSDK/0.0.1

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 Microsoft.Extensions.Logging;
using SocureRiskOsApi.Standard;
using SocureRiskOsApi.Standard.Authentication;

namespace ConsoleApp;

SocureRiskOsApiClient client = new SocureRiskOsApiClient.Builder()
    .BearerAuthCredentials(
        new BearerAuthModel.Builder(
            "AccessToken"
        )
        .Build())
    .HttpClientConfig(httpClientConfig =>
        httpClientConfig.Timeout(TimeSpan.FromSeconds(100)))
    .Environment(SocureRiskOsApi.Standard.Environment.Production)
    .LoggingConfig(config => config
        .LogLevel(LogLevel.Information)
        .RequestConfig(reqConfig => reqConfig.Body(true))
        .ResponseConfig(respConfig => respConfig.Headers(true))
    )
    .Build();

Configuration-Based Initialization

using SocureRiskOsApi.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 = SocureRiskOsApiClient
    .FromConfiguration(configuration.GetSection("SocureRiskOsApi"));

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)

List of APIs

• Reason Codes
• Evaluation
• Feedback

SDK Infrastructure

Configuration

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

HTTP

• HttpCallback
• HttpContext
• HttpRequest
• HttpResponse
• HttpStringResponse

Utilities

• ApiException
• ApiResponse
• ApiHelper
• CustomDateTimeConverter
• UnixDateTimeConverter