Fingerprint Server API Dotnet SDK

Fingerprint is a device intelligence platform offering 99.5% accurate visitor identification. Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device.

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

• API version: 3
• SDK version: 5.0.0
• Build package: io.swagger.codegen.v3.generators.dotnet.CSharpClientCodegen

Requirements

• .NET 6.0 or later (we keep the Microsoft support policy)

Dependencies (installed automatically when adding the package)

• RestSharp - 108.0.3 or later
• Json.NET - 13.0.2 or later

How to install

We recommend installing the package from NuGet:

dotnet add package FingerprintPro.ServerSdk

Getting Started

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

// Import namespaces
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
};

Sealed results

This SDK provides utility methods for decoding sealed results.

using FingerprintPro.ServerSdk;

var sealedResult = Environment.GetEnvironmentVariable("BASE64_SEALED_RESULT")!;
var sealedKey = Environment.GetEnvironmentVariable("BASE64_KEY")!;

var events = Sealed.UnsealEventResponse(Convert.FromBase64String(sealedResult), new[]
{
    new Sealed.DecryptionKey(Convert.FromBase64String(sealedKey), Sealed.DecryptionAlgorithm.Aes256Gcm)
});

Console.WriteLine(events.ToJson());

To learn more, refer to example located in src/FingerprintPro.ServerSdk.SealedResultExampleNet7/Program.cs.

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
FingerprintApi	GetEvent	GET /events/{request_id}	Get event by requestId
FingerprintApi	GetVisits	GET /visitors/{visitor_id}	Get visits by visitorId

Documentation for Models

• Model.ASN
• Model.BotdDetectionResult
• Model.BotdResult
• Model.BrowserDetails
• Model.ClonedAppResult
• Model.Confidence
• Model.DataCenter
• Model.DeprecatedIPLocation
• Model.DeprecatedIPLocationCity
• Model.EmulatorResult
• Model.ErrorEvent403Response
• Model.ErrorEvent403ResponseError
• Model.ErrorEvent404Response
• Model.ErrorEvent404ResponseError
• Model.ErrorVisits403
• Model.EventResponse
• Model.FactoryResetResult
• Model.FridaResult
• Model.HighActivityResult
• Model.IPLocation
• Model.IPLocationCity
• Model.IdentificationError
• Model.IncognitoResult
• Model.IpBlockListResult
• Model.IpBlockListResultDetails
• Model.IpInfoResult
• Model.IpInfoResultV4
• Model.IpInfoResultV6
• Model.JailbrokenResult
• Model.Location
• Model.LocationSpoofingResult
• Model.ManyRequestsResponse
• Model.PrivacySettingsResult
• Model.ProductError
• Model.ProductsResponse
• Model.ProductsResponseBotd
• Model.ProductsResponseIdentification
• Model.ProductsResponseIdentificationData
• Model.ProxyResult
• Model.RawDeviceAttributesResult
• Model.Response
• Model.ResponseVisits
• Model.RootAppsResult
• Model.SeenAt
• Model.SignalResponseClonedApp
• Model.SignalResponseEmulator
• Model.SignalResponseFactoryReset
• Model.SignalResponseFrida
• Model.SignalResponseHighActivity
• Model.SignalResponseIncognito
• Model.SignalResponseIpBlocklist
• Model.SignalResponseIpInfo
• Model.SignalResponseJailbroken
• Model.SignalResponseLocationSpoofing
• Model.SignalResponsePrivacySettings
• Model.SignalResponseProxy
• Model.SignalResponseRawDeviceAttributes
• Model.SignalResponseRootApps
• Model.SignalResponseSuspectScore
• Model.SignalResponseTampering
• Model.SignalResponseTor
• Model.SignalResponseVirtualMachine
• Model.SignalResponseVpn
• Model.Subdivision
• Model.SuspectScoreResult
• Model.TamperingResult
• Model.TorResult
• Model.VirtualMachineResult
• Model.Visit
• Model.VpnResult
• Model.VpnResultMethods
• Model.WebhookVisit

Documentation for Authorization

ApiKeyHeader

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

ApiKeyQuery

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

Documentation for sealed results

• Sealed
• DecryptionKey

Support and feedback

To report problems, ask questions or provide feedback, please use Issues. If you need private support, you can email us at oss-support@fingerprint.com.

License

This project is licensed under the MIT license.