Complete SDK Reference

ZKAuth SDK Reference

Complete API documentation for all ZKAuth SDKs. Choose your preferred language and start building secure applications.

Choose Your SDK

Select your preferred programming language and framework

javascript icon

JavaScript/TypeScript

v1.4.x

Install:

bash
npm install your-zkauth-http-client
python icon

Python (coming soon)

planned

Install:

bash
SDK planned – use HTTP API today
go icon

Go (coming soon)

planned

Install:

bash
SDK planned – use HTTP API today
rust icon

Rust (coming soon)

planned

Install:

bash
SDK planned – use HTTP API today

JavaScript SDK

Installation

bash
npm install your-zkauth-http-client

Basic Usage

javascript
import { ZKAuthSDK } from 'your-zkauth-http-client';

const zkauth = new ZKAuthSDK({
  apiKey: 'zka_live_your_api_key_here',
  baseUrl: 'https://zkp-engine-main-1.vercel.app'
});

const registerResult = await zkauth.register({
  email: 'user@example.com',
  password: 'secure_password',
  deviceInfo: { deviceName: 'Chrome on Mac', deviceType: 'desktop' }
});

const session = await zkauth.login({
  email: 'user@example.com',
  password: 'secure_password',
  deviceInfo: { deviceName: 'Chrome on Mac', deviceType: 'desktop' }
});

React Integration

Installation

bash
npm install ./zkauth-react-helper

Usage

jsx
import { useZKAuth } from './zkauth-react-helper';

function App() {
  const { user, signIn, signOut } = useZKAuth();

  return (
    <div>
      {user ? (
        <div>
          <p>Welcome, {user.email}!</p>
          <button onClick={signOut}>Sign Out</button>
        </div>
      ) : (
        <button onClick={() => signIn({email: 'user@example.com', password: 'password'})}>
          Sign In
        </button>
      )}
    </div>
  );
}

Ready to Integrate?

Start building secure applications with ZKAuth today.