Fingerprint is a device intelligence platform offering 99.5% accurate visitor identification.
The Fingerprint Server Node SDK is an easy way to interact with the Fingerprint Server API from your Node application. You can retrieve visitor history or individual identification events.
TypeScript support:
- TypeScript 4.5.5 or higher
Supported runtimes:
-
Node.js 18 LTS or higher (we support all Node LTS releases before end-of-life).
-
Deno and Bun might work but are not actively tested.
-
"Edge" runtimes might work with some modifications but are not actively tested.
See "edge" runtimes compatibility
This SDK can be made compatible with JavaScript "edge" runtimes that do not support all Node APIs, for example, Vercel Edge Runtime, or Cloudflare Workers.
To make it work, replace the SDK's built-in
fetchfunction (which relies on Node APIs) with the runtime's nativefetchfunction. Pass the function into the constructor with proper binding:const client = new FingerprintJsServerApiClient({ region: Region.EU, apiKey: apiKey, fetch: fetch.bind(globalThis), })
Install the package using your favorite package manager:
-
NPM:
npm i @fingerprintjs/fingerprintjs-pro-server-api
-
Yarn:
yarn add @fingerprintjs/fingerprintjs-pro-server-api
-
pnpm:
pnpm i @fingerprintjs/fingerprintjs-pro-server-api
Initialize the client instance and use it to make API requests. You need to specify your Fingerprint Secret API key and the region of your Fingerprint application.
import {
FingerprintJsServerApiClient,
Region,
} from '@fingerprintjs/fingerprintjs-pro-server-api'
const client = new FingerprintJsServerApiClient({
apiKey: '<SECRET_API_KEY>',
region: Region.Global,
})
// Get visit history of a specific visitor
client.getVisitorHistory('<visitorId>').then((visitorHistory) => {
console.log(visitorHistory)
})
// Get a specific identification event
client.getEvent('<requestId>').then((event) => {
console.log(event)
})See the Examples folder for more detailed examples.
The Server API methods like getEvent and getVisitorHistory can throw EventError and VisitorsError.
You can use the provided isVisitorsError and isEventError type guards to narrow down error types:
import {
isVisitorsError,
isEventError,
FingerprintJsServerApiClient,
} from '@fingerprintjs/fingerprintjs-pro-server-api'
const client = new FingerprintJsServerApiClient({
apiKey: '<SECRET_API_KEY>',
region: Region.Global,
})
// Handling getEvent errors
try {
const event = await client.getEvent(requestId)
console.log(JSON.stringify(event, null, 2))
} catch (error) {
if (isEventError(error)) {
console.log(error.response) // You can also access the raw response
console.log(`error ${error.status}: `, error.error?.message)
} else {
console.log('unknown error: ', error)
}
}
// Handling getVisitorHistory errors
try {
const visitorHistory = await client.getVisitorHistory(visitorId, {
limit: 10,
})
console.log(JSON.stringify(visitorHistory, null, 2))
} catch (error) {
if (isVisitorsError(error)) {
console.log(error.status, error.error)
if (error.status === 429) {
retryLater(error.retryAfter) // Needs to be implemented on your side
}
} else {
console.error('unknown error: ', error)
}
}When handling Webhooks coming from Fingerprint, you can cast the payload as the built-in VisitWebhook type:
import { VisitWebhook } from '@fingerprintjs/fingerprintjs-pro-server-api'
const visit = visitWebhookBody as unknown as VisitWebhookCustomers on the Enterprise plan can enable Webhook signatures to cryptographically verify the authenticity of incoming webhooks. This SDK provides a utility method for verifying the HMAC signature of the incoming webhook request.
To learn more, see example/validateWebhookSignature.mjs or read the API Reference.
Customers on the Enterprise plan can enable Sealed results to receive the full device intelligence result on the client and unseal it on the server. This SDK provides utility methods for decoding sealed results.
To learn more, see example/unsealResult.mjs or the API Reference.
Customers on the Enterprise plan can Delete all data associated with a specific visitor to comply with privacy regulations. See example/deleteVisitor.mjs or the API Reference.
See the full API reference.
To report problems, ask questions, or provide feedback, please use Issues. If you need private support, you can email us at [email protected].
This project is licensed under the MIT license.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent