Start Here
Getting Started Overview

Getting Started

Status: ✅ Production Ready
Base URL: https://id.optare.one


Quick Start (5 Minutes)

I'm an Architect

1. Get API Credentials

Visit: https://id.optare.one/admin
Settings → API Keys → Create New Key
Copy: API Key & Secret

2. Update Environment

# Add to .env.local
OPTARE_API_KEY=sk_live_xxxxx
OPTARE_API_SECRET=sk_secret_xxxxx

3. Install & Run

pnpm install
pnpm optare:setup

Done!


📚 Documentation Structure

SectionDescription
Getting StartedYou are here
SDKsAll SDK documentation
ConceptsOAuth, Multi-tenancy, Security
Portal GuideAdmin & Client portal guides
API ReferenceAPI documentation

🎯 Choose Your Path

👨‍💻 I'm a Developer

  1. Read: Quick Start
  2. Read: CLI Tool
  3. Read: OAuth Integration
  4. Reference: API Reference

👨‍💼 I'm an Admin

  1. Read: Quick Start
  2. Read: Portal Guide
  3. Reference: Installation

👥 I'm an End User

  1. Read: Quick Start
  2. Read: Client Quick Start

🏗️ I'm an Architect

  1. Read: Concepts
  2. Read: Security
  3. Read: Installation

✨ Key Features

  • ✅ OAuth 2.0 / OIDC integration
  • ✅ RESTful API
  • ✅ Admin & Client portals
  • ✅ CLI automation
  • ✅ SDKs for JS, React, Next.js, Flutter, Android, iOS
  • ✅ Production ready

📞 Next Steps

  1. Choose your path above
  2. Read the relevant guide
  3. Follow the step-by-step instructions
  4. Reference the API docs as needed

Next: Quick Start or Installation