Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@fingerprintjs/fingerprintjs-pro-server-api

Package Overview
Dependencies
Maintainers
2
Versions
44
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@fingerprintjs/fingerprintjs-pro-server-api

Node.js wrapper for [FingerprintJS Sever API](https://dev.fingerprintjs.com/docs/server-api)

  • 0.1.7
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
9.1K
increased by13.41%
Maintainers
2
Weekly downloads
 
Created
Source

FingerprintJS

Current NPM version Monthly downloads from NPM Discord server

[Beta] FingerprintJS Server API Node.js SDK

Node.js wrapper for FingerprintJS Sever API

Usage

Install package

npm i @fingerprintjs/fingerprintjs-pro-server-api

Usage of the Server API

import { FingerprintJsServerApiClient, Region } from 'fingerprintjs-server-api';

// Init client with the give region and api_token
const client = new FingerprintJsServerApiClient({region: Region.Global, apiToken: "<api_token>"});

// Get visitor history
client.getVisitorHistory("<visitorId>").then(visitorHistory => {
    console.log(visitorHistory);
});

Usage of the built-in webhook visit type

const visit = visitWebhookBody as unknown as VisitWebhook;

API


FingerprintJsServerApiClient({region: Region, apiToken: string}) constructor

Creates an instance of the client.

Usage
const client = new FingerprintJsServerApiClient({Region.EU, "<api_token>"});
Params
  • region: Region - a region of the server, possible value Region.EU or Region.Global
  • apiToken: string - API token from the FingerprintJS dashboard

client.getVisitorHistory(visitorId: string, filter?: VisitorHistoryFilter): Promise<VisitorsResponse>

Gets history for the given visitor and given filter, returns a promise with visitor history response.

Usage
client.getVisitorHistory("<visitorId>", filter).then(visitorHistory => {
    console.log(visitorHistory);
});
Params
  • visitorId: string - identifier of the visitor
  • filter?: VisitorHistoryFilter - visitor history filter, more info in the API documentation
Returns
  • Promise<VisitorsResponse> - promise with visitor history response

VisitorHistoryFilter

Filter for querying API - see query parameters.

Usage

const filter = {
    request_id: "<request_id>",
    linked_id: "<linked_id>",
    limit: 5,
    before: "<timeStamp>"
};
Properties
  • request_id: string - filter events by requestId
  • linked_id: string - filter events by custom identifier
  • limit: number - limit scanned results
  • before: number - used to paginate results

Server VisitorsResponse response

{
  "visitorId": "Ibk1527CUFmcnjLwIs4A9",
  "visits": [
    {
      "requestId": "0KSh65EnVoB85JBmloQK",
      "incognito": true,
      "linkedId": "somelinkedId",
      "time": "2019-05-21T16:40:13Z",
      // timestamp of the event with millisecond precision
      "timestamp": 1582299576512,
      "url": "https://www.example.com/login",
      "ip": "61.127.217.15",
      "ipLocation": {
        "accuracyRadius": 10,
        "latitude": 49.982,
        "longitude": 36.2566,
        "postalCode": "61202",
        "timezone": "Europe/Dusseldorf",
        "city": {
          "name": "Dusseldorf"
        },
        "continent": {
          "code": "EU",
          "name": "Europe"
        },
        "country": {
          "code": "DE",
          "name": "Germany"
        },
        "subdivisions": [
          {
            "isoCode": "63",
            "name": "North Rhine-Westphalia"
          }
        ],
      },
      "browserDetails": {
        "browserName": "Chrome",
        "browserMajorVersion": "74",
        "browserFullVersion": "74.0.3729",
        "os": "Windows",
        "osVersion": "7",
        "device": "Other",
        "userAgent": "Mozilla/5.0 (Windows NT 6.1; Win64; x64) ....",
      }
    }
  ],
  // optional, if more results are available for pagination.
  "lastTimestamp": 1582299576512
}

Release new version

Change version in package.json to 1.2.3 and push a commit with the message Release 1.2.3, the npm-publish action will create a new tag v1.2.3 and publish the package to the npm registry.

FAQs

Package last updated on 28 Jul 2021

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc