Skip to main content
The @ave-id/sdk package provides typed helpers for implementing Ave OAuth, OIDC flows, and digital signature functionality in your application.

Install the SDK

npm install @ave-id/sdk

Package Structure

The SDK is organized into multiple entry points for different use cases:

Main Export

Core OAuth functions and utilities
import { buildAuthorizeUrl } from "@ave-id/sdk";

Client Helpers

Browser-side OAuth flows
import { startPkceLogin } from "@ave-id/sdk/client";

Server Helpers

Server-side token exchange
import { exchangeCodeServer } from "@ave-id/sdk/server";

TypeScript Support

The SDK is written in TypeScript and includes full type definitions. All types are exported from the main package:
import type { TokenResponse, UserInfo, Scope } from "@ave-id/sdk";

Next Steps

OAuth Flow

Implement OAuth login in your application

Client Helpers

Use pre-built client-side login functions

Server Helpers

Exchange authorization codes on your backend

Signing API

Request and verify digital signatures

Build docs developers (and LLMs) love