SDK Installation

Install Optare packages to add authentication to your application.

Available Packages

Package	Description	Install Command
`@optare/optareid-js`	Universal TypeScript/JavaScript SDK	`npm install @optare/optareid-js`
`@optare/optareid-react`	React Hooks & Components	`npm install @optare/optareid-react`
`@optare/optareid-cli`	Command Line Interface	`npm install -g @optare/optareid-cli`
`@optare/mcp-server`	Model Context Protocol Server	`npm install @optare/mcp-server`
`@optare/token-storage`	Token Storage Adapters	`npm install @optare/token-storage`

Quick Install

React / Next.js Applications

npm install @optare/optareid-react @optare/optareid-js
# or
pnpm add @optare/optareid-react @optare/optareid-js
# or
yarn add @optare/optareid-react @optare/optareid-js

Node.js / Backend Applications

npm install @optare/optareid-js

CLI Tool (Global)

npm install -g @optare/optareid-cli
 
# Verify installation
optare --version

Package Details

@optare/optareid-js

The core SDK for all JavaScript/TypeScript environments:

OAuth 2.0 / OIDC flows
Token management
API client methods
Works in browsers and Node.js

import { OptareClient } from '@optare/optareid-js';
 
const client = new OptareClient({
  clientId: 'your_client_id',
  issuer: 'https://id.optare.one'
});

@optare/optareid-react

React-specific hooks and components:

useSession() - Get current session state
signIn() / signOut() - Authentication actions
<OptareProvider> - Context provider

import { useSession, signIn, signOut } from '@optare/optareid-react';
 
function Profile() {
  const { data: session, isPending } = useSession();
  
  if (isPending) return <div>Loading...</div>;
  if (!session) return <button onClick={() => signIn('optare')}>Sign In</button>;
  
  return (
    <div>
      <p>Welcome {session.user.name}</p>
      <button onClick={signOut}>Sign Out</button>
    </div>
  );
}

@optare/optareid-cli

Command-line tool for developers:

# Login to your Optare account
optare login
 
# View current session
optare whoami
 
# Generate environment variables
optare env

Peer Dependencies

@optare/optareid-react requires:

React 18+
@optare/optareid-js (auto-installed)

Next Steps

Quick Start Guide - Complete setup walkthrough
Backend Token Verification - Verify tokens on your server
React Hooks Reference - Full hooks documentation

Quick Start Guide Setup Checklist