FingerprintPro.ServerSdk 1.0.0-test.4

This is a prerelease version of FingerprintPro.ServerSdk.

There is a newer version of this package available.
See the version list below for details.

dotnet add package FingerprintPro.ServerSdk --version 1.0.0-test.4

NuGet\Install-Package FingerprintPro.ServerSdk -Version 1.0.0-test.4

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="FingerprintPro.ServerSdk" Version="1.0.0-test.4" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add FingerprintPro.ServerSdk --version 1.0.0-test.4

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: FingerprintPro.ServerSdk, 1.0.0-test.4"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install FingerprintPro.ServerSdk as a Cake Addin
#addin nuget:?package=FingerprintPro.ServerSdk&version=1.0.0-test.4&prerelease

// Install FingerprintPro.ServerSdk as a Cake Tool
#tool nuget:?package=FingerprintPro.ServerSdk&version=1.0.0-test.4&prerelease

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

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

Frameworks supported

.NET 5.0 or later

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

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;

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
};

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.BotdDetectionResult](docs/BotdDetectionResult.md)

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

Author

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

Product	Compatible and additional computed target framework versions.
.NET	net5.0 is compatible. net5.0-windows was computed. net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 was computed. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net5.0
- JsonSubTypes (>= 2.0.1)
- Newtonsoft.Json (>= 13.0.2)
- RestSharp (>= 105.1.0)
net6.0
- JsonSubTypes (>= 2.0.1)
- Newtonsoft.Json (>= 13.0.2)
- RestSharp (>= 105.1.0)
net7.0
- JsonSubTypes (>= 2.0.1)
- Newtonsoft.Json (>= 13.0.2)
- RestSharp (>= 105.1.0)

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
5.0.0	256	3/28/2024
5.0.0-test.1	51	3/28/2024
4.1.0	93	3/28/2024
4.0.0	583	3/18/2024
3.1.0	396	2/13/2024
3.0.0	1,179	1/12/2024
2.4.0	1,085	11/23/2023
2.3.2	335	10/20/2023
2.3.1	182	9/25/2023
2.3.0	167	7/31/2023
2.2.1	955	7/11/2023
2.2.0	431	6/1/2023
2.1.0	130	5/16/2023
2.0.0	1,551	1/30/2023
1.0.0	272	1/23/2023
1.0.0-test.9	102	1/23/2023
1.0.0-test.8	95	1/19/2023
1.0.0-test.7	88	1/18/2023
1.0.0-test.6	101	1/18/2023
1.0.0-test.5	93	1/17/2023
1.0.0-test.4	87	1/17/2023
1.0.0-test.3	94	1/17/2023