Skip to main content

​
Welcome to Viax API

The Viax API is a RESTful API that powers the Viax rideshare platform, connecting passengers with drivers in Colombia. The API provides endpoints for user management, trip booking, driver operations, mapping services, and administrative functions.

​
Base URLs

The API supports multiple environments: 
https://76.13.114.194

​
API Architecture

Viax uses a microservices-oriented architecture with the following service endpoints:

Auth Service

/auth - Authentication and user management

Conductor Service

/conductor - Driver profile, documents, and earnings

Trip Service

/viajes - Trip creation, tracking, and history

Map Service

/map - Geocoding, routing, and location services

Admin Service

/admin - Administrative operations and analytics

​
API Version

Current API version: v1 The API version is included in the service configuration and can be accessed via the apiVersion field in configuration responses.

​
Request Format

All API requests should include the following headers: 
Content-Type: application/json
Accept: application/json
Request bodies should be formatted as JSON: 
{
  "email": "user@example.com",
  "password": "securePassword123"
}

​
Response Format

All API responses follow a consistent structure:

​
Success Response

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    // Response data here
  }
}

​
Error Response

{
  "success": false,
  "message": "Error description",
  "error": "ERROR_CODE"
}

​
Rate Limiting

Currently, the API does not enforce rate limiting, but this may be implemented in future versions.

​
Timeout Configuration

The API has the following timeout settings:
  • Connection Timeout: 30 seconds
  • Receive Timeout: 30 seconds
Clients should implement appropriate timeout handling and retry logic.

​
CORS

The API supports Cross-Origin Resource Sharing (CORS) for web applications. Ensure your requests include appropriate origin headers.

​
Data Types

​
Dates and Times

All timestamps are returned in ISO 8601 format: 
"creado_en": "2024-03-15T14:30:00.000Z"
Dates are stored in UTC and should be converted to local time on the client.

​
Numeric Values

  • IDs: Integer
  • Prices: Float (in Colombian Pesos)
  • Distances: Float (in kilometers)
  • Coordinates: Float (latitude/longitude in decimal degrees)

​
Pagination

Endpoints that return lists support pagination with the following query parameters:
​
page
integer
default:"1"
Page number to retrieve
​
per_page
integer
default:"20"
Number of items per page (max 100)
Paginated responses include metadata: 
{
  "success": true,
  "data": [...],
  "pagination": {
    "page": 1,
    "per_page": 20,
    "total": 150,
    "total_pages": 8
  }
}

​
Next Steps

Authentication

Learn how to authenticate your API requests

Error Handling

Understand error codes and handling

User Registration

Register a new user account

Create Trip

Book a ride

Build docs developers (and LLMs) love

Get started for freeTalk to us