Quickstart

Integrate notabotly into your application in less than 5 minutes using our official Node/TypeScript SDK.

1. Get an API Key

   First, you need to create an application in the dashboard to receive your credentials.

   • Go to the notabotly Dashboard.
   • Create an account and verify your humanity (yes, we dogfood our own product).
   • Once in the dashboard, click Create App.
   • Save your App ID and API Key (API keys are only shown once).

2. Install the SDK

   Add the official SDK to your project using your preferred package manager.

   npm

   npm install notabotly

   pnpm

   pnpm add notabotly

   yarn

   yarn add notabotly

3. Initialize a Verification Session

   On your backend server, generate a verification session whenever a user hits a protected route (e.g., login, checkout).

   import { Notabotly } from 'notabotly';
   
   // 1. Initialize once (or let it read NOTABOTLY_API_KEY from env)
   const nb = new Notabotly();
   
   // 2. Create and wait in one go (Modern & Simple)
   const { session, status } = await nb.verify({
     appId: 'app_your_app_id',
     redirectUrl: 'https://yoursite.com/after-verify'
   });
   
   if (status === 'true') {
     console.log('User is human!');
   }

   Tip

   The session.verify_url should be displayed as a QR code to your user. Most developers use libraries like qrcode or react-qr-code.

4. Static Usage (Even simpler)

   If you prefer not to manage an instance, use the static helpers.

   import { Notabotly } from 'notabotly';
   
   // Make sure NOTABOTLY_API_KEY is set in your environment
   const { session, status } = await Notabotly.verify({
     appId: 'app_abc123',
     redirectUrl: 'https://example.com'
   });

---

Next Steps

Deeper Integration

Explore the API Reference for direct HTTP access or the SDK Reference for advanced usage.