zeno.id 0.3.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +26 -9
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -18,21 +18,24 @@ One package for the browser and the server. `zeno.id/server` holds your API key,
18
18
  ZENO_API_KEY=sk_...
19
19
  ```
20
20
 
21
- 2. Make the proxy route and the API client once, with the key, and mount the route on your site at a path of your choice (`/zeno` here).
21
+ 2. Make the proxy route once, with the key, and mount it on your site at a path of your choice (`/zeno` here).
22
22
  3. In the browser, on a page with an action you want to identify (a login, signup or checkout), `start()` the browser SDK (`zeno.id`) with the same path when the page loads (it gathers signals; nothing is sent or billed), call `identify()` when the user takes the action, the identity check, and send its `requestId` to your server with the action's request.
23
- 4. On your server, `verify` the request ID and allow, challenge or block.
23
+ 4. On your server, make an API client with the same key, `verify` the request ID and allow, challenge or block.
24
24
 
25
25
  ```ts
26
26
  // zeno.ts
27
- import { createClient, createProxy } from 'zeno.id/server'
27
+ import { createProxy } from 'zeno.id/server'
28
28
 
29
29
  // Your proxy route: the browser SDK talks to Zeno through it
30
30
  export const zeno = createProxy(process.env.ZENO_API_KEY)
31
- // For verify() in your server's handlers
32
- export const client = createClient(process.env.ZENO_API_KEY)
33
31
  ```
34
32
 
35
33
  ```ts
34
+ import { createClient } from 'zeno.id/server'
35
+
36
+ // Your API client, made once with the project's API key
37
+ const client = createClient(process.env.ZENO_API_KEY)
38
+
36
39
  // After the password matched:
37
40
  const {
38
41
  action, // 'allow', 'challenge' or 'block'
@@ -277,7 +280,7 @@ The route checks a `POST` before it calls Zeno: a JSON body of at most 128 KB wi
277
280
 
278
281
  ## Verify
279
282
 
280
- `client.verify(requestId, { ip?, externalId?, maxAge? }?)` sends the request ID to `POST /verify`, which checks it and answers `{ action, reasons, event? }`. Each request ID verifies once. The event comes with its `velocity`, as `getEvent` has it, from before verify attached your `externalId`: `event.velocity['24h'].distinctExternalId` counts the users seen on this browser today, and `sameAction` its events with this event's action, for a site without external IDs. Identical devices can look like one browser, so treat a busy one as a lead to review.
283
+ `client.verify(requestId, { ip?, externalId?, maxAge?, idempotencyKey? }?)` sends the request ID to `POST /verify`, which checks it and answers `{ action, reasons, event? }`. Each request ID verifies once. The event comes with its `velocity`, as `getEvent` has it, from before verify attached your `externalId`: `event.velocity['24h'].distinctExternalId` counts the users seen on this browser today, and `sameAction` its events with this event's action, for a site without external IDs. Identical devices can look like one browser, so treat a busy one as a lead to review.
281
284
 
282
285
  | Answer | When |
283
286
  | --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
@@ -302,10 +305,24 @@ const { action } = await client.verify(requestId, {
302
305
 
303
306
  `ip` is optional: pass the same client IP your proxy route got, not your load balancer's, and a request ID sent from another ip blocks with `ip-mismatch`; leave it out (or pass `null` or `undefined`) and there's no ip check, as there's none between an IPv4 and an IPv6 address. `no-request-id` is a `challenge` so you decide: ask for a second factor, or let it through and flag the account; never treat it as verified. API errors throw a `ZenoError`.
304
307
 
308
+ A lost answer is safe to retry. Each call sends an `idempotencyKey`, and after a network error or a `5xx` the SDK sends it again, twice at most, with the same key; a repeat with the same key within 5 minutes answers what the first call did instead of `already-used`. If your own code may send the same verify again (a retried job, a second try of your handler), pass your own `idempotencyKey`, 8 to 128 characters, like your request's ID.
309
+
310
+ ### Test keys
311
+
312
+ For automated tests and staging, use a test key in place of your API key, in `createProxy` and `createClient`. Each answers `verify` the same every time, with a sample event; nothing is stored or billed, a test request ID can be verified again and again, and other calls refuse a test key. Without a request ID each answers `challenge` with `no-request-id`, like a real key.
313
+
314
+ | Test key | `verify` answers |
315
+ | ------------------- | ----------------------- |
316
+ | `sk_test_allow` | `allow` |
317
+ | `sk_test_challenge` | `challenge`, with `vpn` |
318
+ | `sk_test_block` | `block`, with `bad-bot` |
319
+
305
320
  ## Server API
306
321
 
307
322
  ```ts
308
- import { client } from './zeno' // made next to your proxy route
323
+ import { createClient } from 'zeno.id/server'
324
+
325
+ const client = createClient(process.env.ZENO_API_KEY)
309
326
 
310
327
  const event = await client.getEvent(requestId)
311
328
  const { items, cursor } = await client.searchEvents({
@@ -344,7 +361,7 @@ const { url } = await client.createEmbed({
344
361
 
345
362
  | Method | Call |
346
363
  | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
347
- | `verify(requestId, { ip?, externalId?, maxAge? }?)` | `POST /verify` |
364
+ | `verify(requestId, { ip?, externalId?, maxAge?, idempotencyKey? }?)` | `POST /verify` |
348
365
  | `getEvent(requestId)` | `GET /events/{requestId}` |
349
366
  | `searchEvents(filters)` | `GET /events?...` |
350
367
  | `getVisitor(visitorId)` | `GET /visitors/{visitorId}` |
@@ -362,7 +379,7 @@ A list filter (`apiKeyId`, `country`, `origin`, `asn`, `browser`, `os`, `action`
362
379
 
363
380
  A failed call throws a `ZenoError` with the `status` and the API's error `code` (`ZenoErrorCode`), like `not_found`. A call answered `429 rate_limited` or `503 search_unavailable` is sent again after the API's `Retry-After`, twice, a little later each time at random so calls limited together don't all come back at once; the error of one that stays limited has `retryAfter` in seconds. Neither was carried out, so retrying a write or a delete is safe.
364
381
 
365
- The SDK's own codes: `network_error` (status `0`) when the API can't be reached or doesn't answer within 10 seconds, never retried; `invalid_request` with status `0` for an empty id (`getEvent('')`), refused before anything is sent; `request_failed` for an error answer without a code, or a success answer that isn't what the call returns (each answer is checked before it's handed back, so something between your server and Zeno that answers otherwise fails here rather than later in your code).
382
+ The SDK's own codes: `network_error` (status `0`) when the API can't be reached or doesn't answer within 10 seconds, retried only for `verify` (above); `invalid_request` with status `0` for an empty id (`getEvent('')`), refused before anything is sent; `request_failed` for an error answer without a code, or a success answer that isn't what the call returns (each answer is checked before it's handed back, so something between your server and Zeno that answers otherwise fails here rather than later in your code).
366
383
 
367
384
  `addRelation` is the one billed call: each is billed like an identification and counts toward the free monthly identifications and the spend limits (reads, `createEmbed` and what events relate by themselves are free). Once a spend limit you set for the project, its organization or the key is reached it throws a `402` `spend_limit_reached` and adds nothing. Every call answers `402` `account_closed` while Zeno has closed the organization's account (for unpaid invoices); contact support to reopen it.
368
385
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zeno.id",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "description": "Zeno's SDK for device identification: the browser SDK, and the proxy route and API client for your server",
5
5
  "license": "MIT",
6
6
  "files": [