Skip to main content

Changelog

All notable changes to the SoshiaConnect API and Portal are documented here.

[1.0.0] - 2025-01-15​

Added​

  • 🎉 Initial public release of SoshiaConnect API
  • Complete RESTful API with 47 endpoints across 9 categories
  • Web Portal at https://soshiaconnect.soshianest.ai/
  • User authentication (Bearer tokens and API keys)
  • Subscription management system
  • Payment processing via Stripe
  • Partner program with commission tracking
  • Analytics and reporting dashboard
  • Comprehensive API documentation
  • Interactive API reference with Redocusaurus

API Endpoints​

  • Authentication & User Management (10 endpoints)

    • User registration and login
    • Profile management
    • Password reset and OTP verification

  • API Key Management (6 endpoints)

    • Generate, list, update, and delete API keys
    • Key status management
    • Export functionality

  • Route Management (5 endpoints)

    • Browse shipping routes
    • Route data access
    • Hierarchical route structure

  • Subscription & Payment Management (8 endpoints)

    • Price calculation
    • Payment intent creation
    • Subscription lifecycle management

  • Partner Management (5 endpoints)

    • Payout setup
    • Onboarding links
    • Commission tracking

  • Analytics & Reporting (7 endpoints)

    • Usage statistics
    • API call logs
    • Report analytics

  • External API Consumption (1 endpoint)

    • Route data access for integrations

  • System Utilities (1 endpoint)

    • Stripe webhook handling

Portal Features​

  • User-friendly dashboard
  • Route browser with filters
  • Subscription management
  • API key generation and management
  • Billing and invoice history
  • Usage analytics
  • Partner dashboard
  • Profile and security settings

Documentation​

  • Getting Started guides
  • API authentication guide
  • Quick start tutorial
  • Portal user guide
  • Error handling documentation
  • Rate limiting guide
  • Webhook documentation
  • Best practices guide

Security​

  • JWT-based authentication
  • API key authentication for server-to-server
  • HTTPS-only API endpoints
  • Secure password hashing
  • OTP verification for email
  • Stripe-powered payment security

Versioning​

We use Semantic Versioning for our API.

Format: MAJOR.MINOR.PATCH

  • MAJOR: Breaking changes
  • MINOR: New features, backwards compatible
  • PATCH: Bug fixes, backwards compatible

Deprecation Policy​

When endpoints or features are deprecated:

  1. Announcement: 90 days advance notice
  2. Documentation: Clearly marked as deprecated
  3. Migration Guide: Provided for alternatives
  4. Sunset Date: Specified end-of-life date
  5. Support: Available during deprecation period

Upcoming Features​

See our Roadmap for planned features:

  • 📱 Mobile applications (iOS & Android)
  • 🔔 Real-time notifications via WebSockets
  • 📊 Advanced analytics dashboards
  • 🌍 Multi-language support
  • 🔗 Additional payment providers
  • 🎯 Granular API key permissions
  • 📈 Enhanced reporting capabilities
  • 🤝 Third-party integrations marketplace

Breaking Changes​

None yet - this is our initial release!

When breaking changes are introduced, they will be clearly marked here with:

  • Description of the change
  • Migration path
  • Deprecation timeline
  • Code examples

API Stability​

Our API stability guarantees:

  • Stable Endpoints: Won't be removed without 90-day notice
  • Response Format: New fields may be added, existing fields won't be removed
  • HTTP Status Codes: Consistent error codes
  • Rate Limits: Won't be reduced for existing plans

Feedback​

We value your feedback! Please report issues or suggest features:

Stay Updated​

Legend:

  • ✨ New feature
  • 🐛 Bug fix
  • 🔧 Improvement
  • 📝 Documentation
  • ⚠️ Deprecation
  • 🚨 Breaking change
  • 🔒 Security

Last updated: January 15, 2025