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.

LSP API Documentation

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.

CSP API Documentation

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.

DEV API Documentation

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.

IoTSP API Documentation

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.

Authentication API

Key Features:

User login & registration
Token management
Multi-factor authentication
Session handling

Base URL: https://auth.dedot.io/v1

Workspace

Multi-tenant workspace and account management.

Workspace API

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:

http

de-auth-token: YOUR_AUTH_TOKEN
de-user-agent: YOUR_USER_AGENT
de-auth-device: YOUR_DEVICE_ID

Applies 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 for permission based operations and action logs:

http

Authorization: Bearer <ACCESS_TOKEN>
de-user-agent: YOUR_USER_AGENT
de-auth-token: YOUR_AUTH_TOKEN
de-auth-device: YOUR_DEVICE_ID

Nevertheless, if you are using a 3rd party authentication provider instead of De.auth, set the provider name as de-auth-provider. Note that, the 3rd party authentication provider must be compatible with De. services:

http

Authorization: Bearer <ACCESS_TOKEN>
de-user-agent: YOUR_USER_AGENT
de-auth-token: YOUR_AUTH_TOKEN
de-auth-device: YOUR_DEVICE_ID
de-auth-provider: YOUR_AUTH_PROVIDER // e.g. "google", "facebook", "github"

Note: The de-auth-* headers are truly inforced when your set the ASI Connector auth configuration value to internal. Otherwise, only Authorization and de-user-agent will be relevent.

Use 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 with no user intervention associated:

http

Authorization: Bearer <ACCESS_TOKEN>
de-user-agent: YOUR_USER_AGENT

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

json

{
  "error": false,
  "status": "SUCCESS",
  "data": {
    // Response data
  }
}

Error Response

json

{
  "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:

http

X-RateLimit-Limit: 1000
X-RateLimit-Remaining: 999
X-RateLimit-Reset: 1640995200

Enterprise Plans: Custom rate limits available. Contact sales for details.

Pagination

List endpoints support pagination using query parameters:

http

GET /v1/{service}/resource?page=1&limit=50

Parameters:

page - Page number (default: 1)
limit - Items per page (default: 20, max: 100)

Response:

json

{
  "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

→ Configure Webhooks

SDKs & Client Libraries

Official SDKs available for popular languages:

JavaScript/TypeScript Python Go Rust

→ View All SDKs

Environments

Production

API Base:

https://api.dedot.io

Auth Base:

https://auth.dedot.io

IoT Base:

https://iot.dedot.io

Use for live applications with real data.

Sandbox

API Base:

https://sandbox.api.dedot.io

Auth Base:

https://sandbox.auth.dedot.io

IoT Base:

https://sandbox.iot.dedot.io

Use for testing and development. All transactions are simulated.

→ Access Sandbox Environment

API Status & Monitoring

Check real-time API status and historical uptime:

→ API Status Dashboard

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.

→ View API Changelog

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

Get Started Quick Start Guide

Questions? Check our FAQ or contact support.

API Reference ​

Overview ​

Service Provider APIs ​

Logistics Service Provider (LSP) ​

Commerce Service Provider (CSP) ​

Developer Service Provider (DEV) ​

IoT Service Provider (IoTSP) ​

Authentication ​

Workspace ​

Authentication ​

Workspace Endpoints ​

Service Provider Endpoints ​

1. User-Connected Applications ​

2. Server-to-Server Integration ​

Getting API Credentials ​

Response Format ​

Success Response ​

Error Response ​

Common Error Codes ​

Rate Limits ​

Pagination ​

Webhooks ​

SDKs & Client Libraries ​

Environments ​

Production ​

Sandbox ​

API Status & Monitoring ​

Support & Resources ​

Documentation ​

Community ​

Contact ​

Changelog & Versioning ​

Getting Started ​

API Reference

Overview

Service Provider APIs

Logistics Service Provider (LSP)

Commerce Service Provider (CSP)

Developer Service Provider (DEV)

IoT Service Provider (IoTSP)

Authentication

Workspace

Authentication

Workspace Endpoints

Service Provider Endpoints

1. User-Connected Applications

2. Server-to-Server Integration

Getting API Credentials

Response Format

Success Response

Error Response

Common Error Codes

Rate Limits

Pagination

Webhooks

SDKs & Client Libraries

Environments

Production

Sandbox

API Status & Monitoring

Support & Resources

Documentation

Community

Contact

Changelog & Versioning

Getting Started