Guides
FAQ

Frequently Asked Questions

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

🎯 General Questions

What is Optare?

Optare is a comprehensive OAuth 2.0 and API management platform that provides secure authentication, authorization, and API access control for modern applications.

What does Optare offer?

  • OAuth 2.0 Authentication with OpenID Connect
  • API Management with rate limiting and monitoring
  • User Management with role-based access control
  • Organization Management with hierarchical permissions
  • CLI Tools for automation and batch operations
  • SDK Libraries for easy integration

Who is Optare for?

  • Developers building applications with authentication
  1. Copy and store securely

How long do tokens last?

  • Access Tokens: 1 hour (default)
  • Refresh Tokens: 30 days (default)
  • ID Tokens: 1 hour (default)

🚀 API Questions

What's the API rate limit?

  • Standard: 1000 requests per hour
  • Premium: 10000 requests per hour
  • Enterprise: Unlimited with fair use

How do I handle rate limits?

HTTP/1.1 429 Too Many Requests
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1638360000

What data formats are supported?

  • Request: JSON
  • Response: JSON
  • Error: JSON with error codes

How do I handle API errors?

{
  "error": "invalid_request",
  "error_description": "Missing required parameter",
  "error_code": "ERR_001"
}

💻 CLI Questions

How do I install the CLI?

# Clone the repository
git clone https://github.com/your-org/optare-cli.git
cd optare-cli
 
# Install dependencies
pnpm install
 
# Set up environment
cp .env.example .env.local
# Edit .env.local with your credentials
 
# Run CLI
pnpm optare:cli --help

What CLI commands are available?

  • product:create - Create new product
  • product:list - List all products
  • product:get - Get product details
  • subscription:create - Create subscription
  • subscription:list - List subscriptions
  • subscription:update - Update subscription
  • subscription:cancel - Cancel subscription
  • setup - Batch setup from config

How do I configure the CLI?

Create optare-config.json:

{
  "products": [
    {
      "name": "Premium Plan",
      "slug": "premium",
      "price": 29.99,
      "description": "Premium features"
    }
  ],
  "subscriptions": [
    {
      "productSlug": "premium",
      "userId": "user_123",
      "status": "active"
    }
  ]
}

🔧 Integration Questions

How do I integrate with my application?

  1. Choose integration method (OAuth, API, SDK)
  2. Follow the Integration Guide
  3. Test with our CLI Tools
  4. Deploy to production

What programming languages are supported?

  • TypeScript/JavaScript (official SDK)
  • Python (community SDK)
  • Ruby (community SDK)
  • Java (community SDK)
  • Go (community SDK)

How do I handle webhooks?

  1. Configure webhook URL in Admin Portal

🔍 Troubleshooting

Common OAuth Issues

  • Invalid redirect URI: Check configuration
  • Missing client credentials: Verify API keys
  • Expired tokens: Implement refresh flow
  • Invalid scopes: Check requested permissions

Common API Issues

  • 401 Unauthorized: Check authentication
  • 403 Forbidden: Check permissions
  • 429 Rate Limited: Implement backoff
  • 500 Server Error: Contact support

Common CLI Issues

  • Missing credentials: Check .env.local
  • Invalid config: Validate JSON syntax
  • Network errors: Check connectivity
  • Permission denied: Check API keys

📞 Support

How do I get help?

  • Documentation: Browse these guides
  • FAQ: Check common issues
  • Community: Join our Discord
  • Support: Email support@optare.one

What information to include in support requests?

  • Description: Clear problem description
  • Steps to reproduce: Detailed steps
  • Expected behavior: What should happen
  • Actual behavior: What actually happened
  • Environment: OS, browser, version
  • Logs: Relevant error logs
  • Code: Minimal reproduction example

What's the support response time?

  • Critical: Within 2 hours
  • High: Within 8 hours
  • Medium: Within 24 hours
  • Low: Within 48 hours

📚 Additional Resources

Documentation

Tools

Community

🆕 Updates

Recent Changes

  • v2.1.0: Added webhook support
  • v2.0.0: OAuth 2.0 implementation
  • v1.5.0: CLI automation tools
  • v1.0.0: Initial release

Upcoming Features

  • v2.2.0: Advanced analytics
  • v2.3.0: Custom domains
  • v2.4.0: Multi-tenant support

Need more help? Contact Support or Join our Community (opens in a new tab)

TroubleshootingAPI Reference