FingerprintPro.ServerSdk 1.0.0-test.4

<p align="center"> <a href="https://fingerprint.com"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/fingerprintjs/fingerprint-pro-server-api-dotnet-sdk/main/res/logo_light.svg" /> <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/fingerprintjs/fingerprint-pro-server-api-dotnet-sdk/main/res/logo_dark.svg" /> <img src="https://raw.githubusercontent.com/fingerprintjs/fingerprint-pro-server-api-dotnet-sdk/main/res/logo_dark.svg" alt="Fingerprint logo" width="312px" /> </picture> </a> </p> <p align="center"> <a href="https://github.com/fingerprintjs/fingerprint-pro-server-api-dotnet-sdk/actions/workflows/release.yml"> <img src="https://github.com/fingerprintjs/fingerprint-pro-server-api-dotnet-sdk/actions/workflows/release.yml/badge.svg" alt="CI badge" /> </a> <a href="https://github.com/fingerprintjs/fingerprint-pro-server-api-dotnet-sdk/actions/workflows/tests.yml"> <img src="https://github.com/fingerprintjs/fingerprint-pro-server-api-dotnet-sdk/actions/workflows/tests.yml/badge.svg" alt="CI badge" /> </a> <a href="https://opensource.org/licenses/MIT"> <img src="https://img.shields.io/:license-mit-blue.svg?style=flat"/> </a> <a href="https://discord.gg/39EpE2neBg"> <img src="https://img.shields.io/discord/852099967190433792?style=logo&label=Discord&logo=Discord&logoColor=white" alt="Discord server"> </a> </p>

FingerprintPro.ServerSdk - the C# library for the Fingerprint Pro Server API

Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. This API can be used for data exports, decision-making, and data analysis scenarios.

This C# SDK is automatically generated by the Swagger Codegen project:

• API version: 3
• SDK version: 1.0.0-test.4
• Build package: io.swagger.codegen.v3.generators.dotnet.CSharpClientCodegen

<a name="frameworks-supported"></a>

Frameworks supported

• .NET 5.0 or later

<a name="dependencies"></a>

Dependencies

• RestSharp - 105.1.0 or later
• Json.NET - 7.0.0 or later
• JsonSubTypes - 1.2.0 or later

The DLLs included in the package may not be the latest version. We recommend using NuGet to obtain the latest version of the packages:

Install-Package RestSharp
Install-Package Newtonsoft.Json
Install-Package JsonSubTypes

NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See RestSharp#742

<a name="installation"></a>

Installation

// TODO Update this section once package is published to nuget

Run the following command to generate the DLL

• [Mac/Linux] /bin/sh build.sh
• [Windows] build.bat

Then include the DLL (under the bin folder) in the C# project, and use the namespaces:

using FingerprintPro.ServerSdk.Api;
using FingerprintPro.ServerSdk.Client;
using FingerprintPro.ServerSdk.Model;

<a name="getting-started"></a>

Getting Started

// See https://aka.ms/new-console-template for more information
// Example usage of our SDK

using FingerprintPro.ServerSdk.Api;
using FingerprintPro.ServerSdk.Client;

// Initialize configuration and add your api key
var configuration = new Configuration(Environment.GetEnvironmentVariable("API_KEY")!);

var api = new FingerprintApi(
configuration
);

var requestId = Environment.GetEnvironmentVariable("REQUEST_ID")!;
var visitorId = Environment.GetEnvironmentVariable("VISITOR_ID")!;

var visits = api.GetVisits(visitorId);
var events = api.GetEvent(requestId);

Console.WriteLine(visits);
Console.WriteLine(events);

Region

If your subscription is in region other than US, you need to change the region in the configuration:

using FingerprintPro.ServerSdk.Client;

var configuration = new Configuration(Environment.GetEnvironmentVariable("API_KEY")!)
{
    Region = Region.Eu // or Region.Asia
};

<a name="documentation-for-api-endpoints"></a>

Documentation for API Endpoints

All URIs are relative to https://api.fpjs.io

<a name="documentation-for-models"></a>

Documentation for Models

 - [Model.BotdDetectionResult](docs/BotdDetectionResult.md)

• Model.BotdError
• Model.BotdResult
• Model.BrowserDetails
• Model.Confidence
• Model.ErrorEvent403Response
• Model.ErrorEvent403ResponseError
• Model.ErrorEvent404Response
• Model.ErrorEvent404ResponseError
• Model.EventResponse
• Model.IPLocation
• Model.IPLocationCity
• Model.Location
• Model.ManyRequestsResponse
• Model.ProductsResponse
• Model.ProductsResponseBotd
• Model.ProductsResponseIdentification
• Model.ProductsResponseIdentificationData
• Model.Response
• Model.ResponseVisits
• Model.SeenAt
• Model.Subdivision
• Model.Visit
• Model.WebhookVisit

<a name="documentation-for-authorization"></a>

Documentation for Authorization

<a name="ApiKeyHeader"></a>

ApiKeyHeader

• Type: API key
• API key parameter name: Auth-API-Key
• Location: HTTP header

<a name="ApiKeyQuery"></a>

ApiKeyQuery

• Type: API key
• API key parameter name: api_key
• Location: URL query string

<a name="Author"></a>

Author

<a href="mailto:support@fingerprint.com">support@fingerprint.com</a>