Skip to main content
API docs by Redocly

Soshiaconnect Public APIs (1.0.0)

Download OpenAPI specification:Download

Soshiaconnect Support: support@soshiaconnect.com License: Proprietary

Comprehensive API for Soshiaconnect shipping and maritime data platform.

Authentication

This API uses Bearer token authentication for protected endpoints and API Key authentication for external integrations.

Bearer Token Authentication

Include the token in the Authorization header: Authorization: Bearer {token}

API Key Authentication

Include these headers:

  • X-API-Key: Your API key
  • X-Username: Your username

Base URL

Production: https://api.soshiaconnect.com

Authentication

User registration, login, logout, and session management

Register New User

Creates a new user account in the Soshiaconnect system. Email verification is required before the account can be used.

Process Flow:

  1. Submit registration details
  2. Receive confirmation email
  3. Verify email address
  4. Account activated
Authorizations:
BearerAuth
Request Body schema: application/json
required

User registration information

email
required
string <email>

User's email address (must be unique)

password
required
string <password> >= 8 characters

Password (minimum 8 characters, must include uppercase, lowercase, and number)

firstName
required
string [ 2 .. 50 ] characters

User's first name

lastName
required
string [ 2 .. 50 ] characters

User's last name

userType
required
string
Enum: "partner" "admin" "viewer"

Type of user account

company
string <= 100 characters

Company name (optional)

phoneNumber
string^\+?[1-9]\d{1,14}$

Phone number in E.164 format

Responses

Request samples

Content type
application/json
{
  • "email": "john.doe@example.com",
  • "password": "SecurePass123!",
  • "firstName": "John",
  • "lastName": "Doe",
  • "userType": "partner",
  • "company": "Acme Shipping Co.",
  • "phoneNumber": "+12025551234"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Registration successful. Please check your email to verify your account.",
  • "data": {
    }
}

User Login

Authenticates a user with email and password credentials. Returns an access token for subsequent API calls.

Token Usage:

  • Include in Authorization header: Bearer {token}
  • Token expires in 24 hours
  • Refresh token provided for extended sessions
Authorizations:
BearerAuth
Request Body schema: application/json
required

Login credentials

email
required
string <email>

Registered email address

password
required
string <password>

User password

rememberMe
boolean
Default: false

Extend session duration to 30 days

Responses

Request samples

Content type
application/json
{
  • "email": "john.doe@example.com",
  • "password": "SecurePass123!",
  • "rememberMe": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Login successful",
  • "data": {
    }
}

User Logout

Invalidates the current user session and access token. The token cannot be used for subsequent requests after logout.

Best Practice:

  • Always call this endpoint when user logs out
  • Clear token from client-side storage
Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "message": "Logout successful"
}

Users and Plans

User types and SaaS subscription plans

Get Available User Types

Retrieves the list of available user types for registration. Use this endpoint to populate user type dropdowns in registration forms.

User Types:

  • Partner: Full access to platform features
  • Admin: Administrative access
  • Viewer: Read-only access
Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Get SaaS Subscription Plans

Retrieves available SaaS subscription plans with pricing and feature information.

Plans Include:

  • Pricing tiers
  • Feature lists
  • Usage limits
  • Billing periods
Authorizations:
BearerAuth
header Parameters
X-API-Key
string
Example: sk_live_1a2b3c4d5e6f7g8h9i0j

Optional API key for external access

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Routes

Shipping routes, schedules, and route data

Get All Available Routes

Retrieves a complete list of all available shipping routes in the system.

Response includes:

  • Route identifiers
  • Origin and destination ports
  • Route status
  • Available vessels

Authentication:

  • Bearer token (for registered users)
  • API Key + Username (for external integrations)
Authorizations:
BearerAuthApiKeyAuthNone
query Parameters
status
string
Enum: "active" "inactive" "scheduled"
Example: status=active

Filter by route status

origin
string
Example: origin=USNYC

Filter by origin port code

destination
string
Example: destination=CNSHA

Filter by destination port code

page
integer >= 1
Default: 1
Example: page=1

Page number for pagination

limit
integer [ 1 .. 100 ]
Default: 20
Example: limit=20

Number of results per page

header Parameters
X-API-Key
string
Example: sk_live_1a2b3c4d5e6f7g8h9i0j

API key for external consumption

X-Username
string
Example: john.doe@example.com

Username associated with API key

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "pagination": {
    }
}

Get Route Hierarchy

Retrieves hierarchical structure of shipping routes with access limitations based on user subscription level.

Hierarchy Levels:

  1. Regions (e.g., Asia-Pacific, Europe, Americas)
  2. Sub-regions (e.g., East Asia, Southeast Asia)
  3. Trade lanes (e.g., Trans-Pacific, Trans-Atlantic)
  4. Specific routes

Access Control:

  • Free tier: Limited routes
  • Starter plan: Regional routes
  • Professional plan: All major routes
  • Enterprise plan: All routes + custom routes
Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get Shipping Period Details

Retrieves detailed shipping schedule and period information for a specific time period.

Information Includes:

  • Departure schedules
  • Arrival schedules
  • Vessel assignments
  • Capacity information
  • Booking status
Authorizations:
BearerAuth
path Parameters
period_id
required
string
Example: period_2024_q4

Unique identifier for the shipping period

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get Available Subscription Durations

Retrieves available subscription duration options for dropdown selection in subscription forms.

Common Options:

  • Monthly
  • Quarterly
  • Semi-annually
  • Annually

Includes:

  • Duration in months
  • Display labels
  • Discount percentages (if applicable)
Authorizations:
BearerAuth

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}

Get Single Route Data (External API)

External API endpoint for retrieving detailed data for a specific shipping route using API key authentication.

Use Cases:

  • Third-party integrations
  • Mobile applications
  • Partner systems

Rate Limits:

  • Starter: 1000 calls/month
  • Professional: 10000 calls/month
  • Enterprise: Unlimited

Response Includes:

  • Complete route details
  • Current vessel positions
  • Historical performance data
  • Pricing information (if accessible)
Authorizations:
ApiKeyAuth
query Parameters
id
required
string
Example: id=route_001

Unique route identifier

includeVessels
boolean
Default: false
Example: includeVessels=true

Include detailed vessel information

includeSchedule
boolean
Default: false
Example: includeSchedule=true

Include upcoming schedule

includePricing
boolean
Default: false
Example: includePricing=true

Include pricing information (requires premium plan)

header Parameters
X-API-Key
required
string
Example: sk_live_1a2b3c4d5e6f7g8h9i0j

Your API key for authentication

X-Username
required
string
Example: john.doe@example.com

Username associated with the API key

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}