Skip to content

Commit

Permalink
Merge pull request #88 from fingerprintjs/docs/update-js-agent-links
Browse files Browse the repository at this point in the history
chore: update javascript agent links
  • Loading branch information
ilfa authored Sep 11, 2024
2 parents 0e44a30 + f2d33f8 commit acd2b3f
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ const fpjsClient = new FpjsClient({
```

> [!NOTE]
> You must provide `loadOptions` containing your public API key either in the constructor or in the `init` method. If you don't, the SDK will throw an error. You can learn more about different load options here in the [JS Agent documentation](https://dev.fingerprint.com/docs/js-agent#initializing-the-agent).
> You must provide `loadOptions` containing your public API key either in the constructor or in the `init` method. If you don't, the SDK will throw an error. You can learn more about different load options here in the [JS Agent documentation](https://dev.fingerprint.com/reference/load-function).
### 3. Initialize the JS Agent

Expand Down Expand Up @@ -128,7 +128,7 @@ await fpjsClient.init({

### 4. Identify visitors

The `getVisitorData` method returns visitor identification data based on the request [options](https://dev.fingerprint.com/docs/js-agent#get-options).
The `getVisitorData` method returns visitor identification data based on the request [options](https://dev.fingerprint.com/reference/get-function#get-options).
Set `ignoreCache` to `true` to call the API even if the data is present in the cache.

```js
Expand All @@ -142,7 +142,7 @@ const visitorData = fpjsClient.getVisitorData({ extendedResult: true }).then((vi
})
```

See the [JS Agent API reference](https://dev.fingerprint.com/docs/js-agent) for more details.
See the [JS Agent API reference](https://dev.fingerprint.com/reference/javascript-agent) for more details.

#### Linking and tagging information

Expand Down Expand Up @@ -183,7 +183,7 @@ const fpjsClient = new FpjsClient({
Cache keys are based on the combination of _GetOptions_. For example, API responses for calls with `extendedResult: true` and `extendedResult: false` are stored independently.

> [!NOTE]
> If you use data from [`extendedResult`](https://dev.fingerprint.com/docs/js-agent#extendedresult), pay additional attention to your caching strategy. Some fields, for example, `ip` or `lastSeenAt`, might change over time for the same visitor.
> If you use data from [`extendedResult`](https://dev.fingerprint.com/reference/get-function#extendedresult), pay additional attention to your caching strategy. Some fields, for example, `ip` or `lastSeenAt`, might change over time for the same visitor.
You can ignore the cached result for a specific API call and using `{ ignoreCache: true }`:

Expand Down

0 comments on commit acd2b3f

Please sign in to comment.