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.2.0

Install:

bash
npm install @zkauth/sdk
python icon

Python

v1.1.0

Install:

bash
pip install zkauth
go icon

Go

v1.0.0

Install:

bash
go get github.com/zkauth/go-sdk
rust icon

Rust

v0.9.0

Install:

bash
cargo add zkauth

JavaScript SDK

Installation

bash
npm install @zkauth/sdk

Basic Usage

javascript
import { ZKAuth } from '@zkauth/sdk';

const zkauth = new ZKAuth({
  apiKey: 'zka_live_your_api_key_here',
  baseURL: 'https://api.zkauth.com'
});

const user = await zkauth.signUp({
  email: 'user@example.com',
  password: 'secure_password'
});

const session = await zkauth.signIn({
  email: 'user@example.com',
  password: 'secure_password'
});

React Integration

Installation

bash
npm install @zkauth/react

Usage

jsx
import { useZKAuth } from '@zkauth/react';

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.