Download OpenAPI specification:Download
Complete API documentation for SoshiaConnect platform with standardized naming conventions and comprehensive endpoint coverage.
The API uses two authentication methods:
Creates a new user account in the system with email verification required
| full_name required | string User's full name for registration |
| organization required | string Organization name the user belongs to |
| number_of_users required | integer Expected number of users in the organization |
| email required | string <email> User's email address for registration |
| password required | string <password> >= 8 characters User's password for registration |
| password_confirmation required | string <password> Password confirmation - must match password field |
| user_type_code required | string Type of user account (partner, admin, etc.) |
| referred_by_partner_id | integer Partner ID if referred by existing partner (optional) |
{- "success": true,
- "message": "Operation completed successfully",
- "data": { }
}Authenticates user and returns access token for subsequent API calls
| email required | string <email> User's registered email address |
| password required | string <password> User's account password |
{- "access_token": "string",
- "token_type": "Bearer",
- "user": {
- "id": 1,
- "full_name": "John Doe",
- "email": "john.doe@acme.com",
- "organization": "Acme Corp",
- "number_of_users": 50,
- "mobile_number": "+1234567890",
- "user_type_code": "partner",
- "status": "active",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}Retrieves the authenticated user's profile information
{- "id": 1,
- "full_name": "John Doe",
- "email": "john.doe@acme.com",
- "organization": "Acme Corp",
- "number_of_users": 50,
- "mobile_number": "+1234567890",
- "user_type_code": "partner",
- "status": "active",
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}Updates the authenticated user's profile information
| full_name | string Updated full name |
| organization | string Updated organization name |
| number_of_users | integer Updated number of users in organization |
string <email> Updated email address | |
| mobile_number | string Updated mobile phone number |
| status | string Enum: "active" "inactive" Account status |
{- "success": true,
- "message": "Operation completed successfully",
- "data": { }
}Changes the authenticated user's password with current password verification
| current_password required | string <password> Current password for verification |
| new_password required | string <password> >= 8 characters New password to set |
| new_password_confirmation required | string <password> Confirmation of new password |
{- "current_password": "pa$$word",
- "new_password": "pa$$word",
- "new_password_confirmation": "pa$$word"
}{- "success": true,
- "message": "Operation completed successfully",
- "data": { }
}Retrieves available SaaS subscription plans and pricing information
| X-API-Key required | string API key for authentication |
[- {
- "id": 0,
- "name": "Professional",
- "price": 99.99,
- "features": [
- "string"
], - "billing_period": "monthly"
}
]Administrative endpoint to delete a user account by email address
| email required | string <email> Email address of user to delete |
{- "success": true,
- "message": "Operation completed successfully",
- "data": { }
}Verifies the OTP code sent to user's email for account verification or password reset
| email required | string <email> Email address associated with OTP |
| otp required | string^\d{6}$ 6-digit OTP code received via email |
| type required | string Enum: "registration" "password_reset" Type of OTP |
{- "success": true,
- "message": "Operation completed successfully",
- "data": { }
}Resends OTP code to the specified email address
| email required | string <email> Email address to resend OTP to |
| type required | string Enum: "registration" "password_reset" Type of OTP to resend |
{- "success": true,
- "message": "Operation completed successfully",
- "data": { }
}Initiates password recovery process by sending OTP to registered email
| email required | string <email> Email address for password recovery |
{- "success": true,
- "message": "Operation completed successfully",
- "data": { }
}Resets user password using verified OTP code
| email required | string <email> Email address for password reset |
| otp required | string^\d{6}$ OTP code received via email |
| password required | string <password> >= 8 characters New password to set |
| password_confirmation required | string <password> Confirmation of new password |
{- "success": true,
- "message": "Operation completed successfully",
- "data": { }
}Retrieves all API keys associated with the authenticated user's account
[- {
- "id": 0,
- "api_key_name": "Production API Key",
- "api_key": "sk_live_xxxxxxxxxxxxx",
- "user": "api_user_1",
- "status": "active",
- "created_at": "2019-08-24T14:15:22Z",
- "last_used_at": "2019-08-24T14:15:22Z"
}
]Generates a new API key with specified name and associated username
| api_key_name required | string Name for the API key |
| user required | string Username to associate with the API key |
{- "api_key_name": "Production API Key",
- "user": "api_user_1"
}{- "id": 0,
- "api_key_name": "Production API Key",
- "api_key": "sk_live_xxxxxxxxxxxxx",
- "user": "api_user_1",
- "status": "active",
- "created_at": "2019-08-24T14:15:22Z",
- "last_used_at": "2019-08-24T14:15:22Z"
}Retrieves detailed information about a specific API key by its ID
| api_key_id required | integer API key ID |
{- "id": 0,
- "api_key_name": "Production API Key",
- "api_key": "sk_live_xxxxxxxxxxxxx",
- "user": "api_user_1",
- "status": "active",
- "created_at": "2019-08-24T14:15:22Z",
- "last_used_at": "2019-08-24T14:15:22Z"
}Updates the status of an API key (active/inactive) to enable or disable access
| api_key_id required | integer API key ID |
| status required | string Enum: "active" "inactive" New status for the API key |
{- "status": "active"
}{- "success": true,
- "message": "Operation completed successfully",
- "data": { }
}Retrieves complete list of all available shipping routes in the system
| X-API-Key required | string API key for authentication |
[- {
- "id": 0,
- "name": "US East Coast Route",
- "code": "US-EC-001",
- "description": "string",
- "status": "active"
}
]Retrieves detailed information about a specific shipping route
| id required | integer Specific route ID to retrieve data for |
| X-API-Key required | string API key for authentication |
{- "id": 0,
- "name": "US East Coast Route",
- "code": "US-EC-001",
- "description": "string",
- "status": "active",
- "periods": [
- {
- "id": 0,
- "period_name": "Q1 2024",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "status": "active"
}
], - "pricing": { }
}Verifies if a specific user has access to a particular shipping route
| user_id required | integer ID of user to check access for |
| route_id required | integer ID of route to check access to |
{- "has_access": true,
- "message": "string"
}Retrieves shipping schedule and period information for a specific period
| period_id required | integer Shipping period ID |
{- "id": 0,
- "period_name": "Q1 2024",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "status": "active"
}Calculates total subscription cost for multiple routes and periods
| period_id[0] | integer Period ID for first route/report |
| report_id[0] | integer Report ID for first route/report |
| subscription_term[0] | string Enum: "1_month" "2_months" "3_months" "6_months" "12_months" Subscription duration |
{- "calculation_id": 0,
- "total_amount": 299.97,
- "currency": "USD",
- "items": [
- {
- "route_id": 0,
- "period_id": 0,
- "price": 0.1,
- "subscription_term": "string"
}
]
}Calculates subscription cost for a single route and period
| period_id required | integer Period ID for pricing calculation |
| subscription_term required | string Enum: "1_month" "2_months" "3_months" "6_months" "12_months" Subscription term duration |
{- "calculation_id": 0,
- "total_amount": 299.97,
- "currency": "USD",
- "items": [
- {
- "route_id": 0,
- "period_id": 0,
- "price": 0.1,
- "subscription_term": "string"
}
]
}Creates Stripe payment intent for processing subscription payment
| total_amount required | number <float> Total amount to charge in dollars |
| currency required | string Enum: "USD" "EUR" "GBP" Currency code |
| calculation_id required | integer ID from previous price calculation |
{- "client_secret": "string",
- "payment_intent_id": "string"
}Confirms successful payment and activates subscription services
| payment_intent_id required | string Stripe payment intent ID from successful payment |
{- "success": true,
- "message": "Operation completed successfully",
- "data": { }
}Retrieves all active route subscriptions for the authenticated user
[- {
- "id": 0,
- "route_id": 0,
- "route_name": "string",
- "period_id": 0,
- "period_name": "string",
- "subscription_term": "3_months",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "status": "active",
- "auto_renew": true
}
]Retrieves complete billing and payment history for the user account
[- {
- "id": 0,
- "payment_intent_id": "string",
- "amount": 0.1,
- "currency": "string",
- "status": "succeeded",
- "description": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
]Processes subscription checkout with selected pricing and duration
| pricing_slabs_id required | integer ID of selected pricing tier |
| subscription required | string Subscription type |
| amount required | number <float> Total checkout amount |
| report_id required | integer Report ID for checkout |
| subscription_term required | string Duration of subscription term |
{- "success": true,
- "message": "Operation completed successfully",
- "data": { }
}Initializes payout configuration for partner account commission payments
| X-API-Key required | string API key for authentication |
{- "success": true,
- "message": "Operation completed successfully",
- "data": { }
}Retrieves current partner account status and verification information
| X-API-Key required | string API key for authentication |
{- "account_id": "string",
- "status": "active",
- "verification_status": "string",
- "can_receive_payouts": true,
- "total_earnings": 0.1,
- "pending_payouts": 0.1
}Retrieves partner payout configuration and earning details
| X-API-Key required | string API key for authentication |
{- "total_earnings": 0.1,
- "paid_out": 0.1,
- "pending": 0.1,
- "next_payout_date": "2019-08-24",
- "payout_method": "string"
}Retrieves comprehensive account statistics including usage and subscription data
{- "total_subscriptions": 0,
- "active_subscriptions": 0,
- "total_api_calls": 0,
- "api_calls_this_month": 0,
- "total_spent": 0.1,
- "active_api_keys": 0
}Retrieves complete API usage history and call logs for the account
[- {
- "id": 0,
- "api_key_id": 0,
- "route_id": 0,
- "endpoint": "string",
- "method": "string",
- "status_code": 0,
- "response_time": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
]Retrieves API usage logs for a specific report ID
| report_id required | integer Report ID |
| X-API-Key required | string API key for authentication |
| X-Username required | string Username associated with API key |
[- {
- "id": 0,
- "api_key_id": 0,
- "route_id": 0,
- "endpoint": "string",
- "method": "string",
- "status_code": 0,
- "response_time": 0,
- "timestamp": "2019-08-24T14:15:22Z"
}
]Retrieves report usage overview and analytics for specified time period
| period required | string Enum: "days" "weeks" "months" "years" Time period for analytics |
{- "period": "string",
- "total_reports": 0,
- "reports_accessed": 0,
- "most_accessed_routes": [
- { }
], - "usage_trend": [
- { }
]
}Retrieves list of subscriptions that will expire soon for renewal planning
[- {
- "id": 0,
- "route_id": 0,
- "route_name": "string",
- "period_id": 0,
- "period_name": "string",
- "subscription_term": "3_months",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "status": "active",
- "auto_renew": true
}
]Retrieves detailed API call usage statistics for specified time period
| period required | string Enum: "days" "weeks" "months" "years" Time period for usage statistics |
{- "period": "string",
- "total_calls": 0,
- "successful_calls": 0,
- "failed_calls": 0,
- "average_response_time": 0.1,
- "peak_usage_time": "14:15:22Z",
- "calls_by_endpoint": [
- { }
]
}External API endpoint for retrieving route data using API key authentication
| id required | integer Route ID to retrieve data for |
| X-API-Key required | string API key for authentication |
| X-Username required | string Username associated with API key |
{- "id": 0,
- "name": "US East Coast Route",
- "code": "US-EC-001",
- "description": "string",
- "status": "active",
- "periods": [
- {
- "id": 0,
- "period_name": "Q1 2024",
- "start_date": "2019-08-24",
- "end_date": "2019-08-24",
- "status": "active"
}
], - "pricing": { }
}Webhook endpoint for processing Stripe payment notifications and events
| Stripe-Signature required | string Stripe webhook signature for verification |
Stripe webhook event payload
{ }