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 & Secret2. Update Environment
# Add to .env.local
OPTARE_API_KEY=sk_live_xxxxx
OPTARE_API_SECRET=sk_secret_xxxxx3. Install & Run
pnpm install
pnpm optare:setupDone! ✅
📚 Documentation Structure
| Section | Description |
|---|---|
| Getting Started | You are here |
| SDKs | All SDK documentation |
| Concepts | OAuth, Multi-tenancy, Security |
| Portal Guide | Admin & Client portal guides |
| API Reference | API documentation |
🎯 Choose Your Path
👨💻 I'm a Developer
- Read: Quick Start
- Read: CLI Tool
- Read: OAuth Integration
- Reference: API Reference
👨💼 I'm an Admin
- Read: Quick Start
- Read: Portal Guide
- Reference: Installation
👥 I'm an End User
- Read: Quick Start
- Read: Client Quick Start
🏗️ I'm an Architect
- Read: Concepts
- Read: Security
- 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
- Choose your path above
- Read the relevant guide
- Follow the step-by-step instructions
- Reference the API docs as needed
Next: Quick Start or Installation