API Reference
Complete API documentation for all De. platform services.
Overview
The De. platform provides comprehensive APIs for building logistics, commerce, IoT, and developer tools applications. All APIs follow RESTful conventions and return JSON responses.
Service Provider APIs
Logistics Service Provider (LSP)
Complete logistics management APIs for freight delivery and passenger transport.
Key Features:
- Fleet management (vehicles, maintenance, parking)
- Carrier network operations
- Hub & warehouse management
- Route optimization
- Pricing & billing
- Coverage management
- Shipment & trip tracking
Base URL: https://api.dedot.io/v1/lsp
Commerce Service Provider (CSP)
E-commerce and marketplace APIs for product catalogs, orders, and transactions.
Key Features:
- User management
- Operator access control
- Order processing
- Invitation system
Base URL: https://api.dedot.io/v1/csp
Developer Service Provider (DEV)
Developer tools and integration APIs for building on the De. platform.
Key Features:
- API key management
- Webhook configuration
- Developer portal access
- FAQs & documentation
- Sandbox environments
Base URL: https://api.dedot.io/v1/dev
IoT Service Provider (IoTSP)
IoT device management and data streaming APIs.
Key Features:
- Device registration & management
- MQTT topic management
- Rules engine for data processing
- Real-time device monitoring
Base URL: https://api.dedot.io/v1/iotsp
Authentication
User authentication and session management.
Key Features:
- User login & registration
- Token management
- Multi-factor authentication
- Session handling
Base URL: https://auth.dedot.io/v1/auth
Workspace
Multi-tenant workspace and account management.
Key Features:
- Workspace creation & management
- Account administration
- Service provider activation
- User & operator management
- Integrations & connectors
Base URL: https://api.dedot.io/v1/workspace
Authentication
De. APIs support multiple authentication patterns depending on your use case.
Workspace Endpoints
Business workspace management requires De. authentication headers:
de-auth-token: YOUR_AUTH_TOKEN
de-user-agent: YOUR_USER_AGENT
de-auth-device: YOUR_DEVICE_IDApplies to: /v1/workspace/* endpoints
Service Provider Endpoints
Choose authentication based on your integration type:
1. User-Connected Applications
For applications using De.auth where user identity must be strictly verified:
de-auth-token: YOUR_AUTH_TOKEN
de-user-agent: YOUR_USER_AGENT
de-auth-device: YOUR_DEVICE_IDUse cases:
- Mobile/web apps with user login
- Applications requiring user session validation
- User-specific operations (orders, shipments, devices)
2. Server-to-Server Integration
For connector-based or service account access:
Authorization: Bearer <ACCESS_TOKEN>Use cases:
- Backend integrations
- Connector applications
- Automated workflows
- System-to-system communication
Getting API Credentials
For User Authentication:
- Implement De.auth in your application
- Users log in and obtain auth tokens
- Use tokens in API requests
For Connector Authentication:
- Create a connector in the Developer Portal
- Generate access token for the connector
- Use
Authorization: Bearer <token>header
→ View Complete Authentication Guide
Response Format
All API responses follow a consistent structure:
Success Response
{
"error": false,
"status": "SUCCESS",
"data": {
// Response data
}
}Error Response
{
"error": true,
"status": "ERROR_CODE",
"message": "Human-readable error message"
}Common Error Codes
| Code | HTTP Status | Description |
|---|---|---|
SUCCESS | 200 | Request completed successfully |
CREATED | 201 | Resource created successfully |
NOT_FOUND | 404 | Resource not found |
UNAUTHORIZED | 401 | Authentication failed or missing |
FORBIDDEN | 403 | Insufficient permissions |
VALIDATION_ERROR | 400 | Invalid request data |
INTERNAL_ERROR | 500 | Server error |
RATE_LIMIT_EXCEEDED | 429 | Too many requests |
Rate Limits
Standard Rate Limits:
- 1,000 requests per hour
- 100 requests per minute (burst)
Rate limit information is included in response headers:
X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200Enterprise Plans: Custom rate limits available. Contact sales for details.
Pagination
List endpoints support pagination using query parameters:
GET /v1/{service}/resource?page=1&limit=50Parameters:
page- Page number (default: 1)limit- Items per page (default: 20, max: 100)
Response:
{
"error": false,
"status": "SUCCESS",
"data": [...],
"pagination": {
"page": 1,
"limit": 50,
"total": 237,
"pages": 5,
"hasNext": true,
"hasPrevious": false
}
}Webhooks
Receive real-time notifications for events in your workspace.
Supported Events:
- Order status changes
- Shipment updates
- Device telemetry
- Payment completions
- User actions
SDKs & Client Libraries
Official SDKs available for popular languages:
Environments
Production
API Base:
https://api.dedot.ioAuth Base:
https://auth.dedot.ioUse for live applications with real data.
Sandbox
API Base:
https://sandbox-api.dedot.ioAuth Base:
https://sandbox-auth.dedot.ioUse for testing and development. All transactions are simulated.
API Status & Monitoring
Check real-time API status and historical uptime:
Subscribe to status updates and incident notifications.
Support & Resources
Documentation
Community
Contact
- Email: [email protected]
- Discord: Join our server
- Enterprise Support: [email protected]
Changelog & Versioning
All APIs are versioned (currently v1). Breaking changes will be introduced in new versions.
Getting Started
- Create Account - Sign up for developer access
- Choose Service - Select the API that fits your needs
- Generate Keys - Create API credentials in the developer dashboard
- Make Requests - Start building with our comprehensive API docs
- Deploy - Go live with production API keys
Questions? Check our FAQ or contact support.