XD Soba Documentation
Powerful API for managing your business using the XD ecosystem
Entity Management
Comprehensive API for managing customers, suppliers, and business entities. Create, update, and track relationships between different entities in your business ecosystem.
Business Operations
Handle core business operations including manual checking accounts, receipt documents, and treasury management. Streamline your financial and operational workflows.
Payment Integration
Seamless payment processing with XDPay integration. Manage transactions, process payments, and handle financial operations securely.
Report Management
API for report generation and management. Supports both standard predefined reports and dynamic custom reports. Retrieve report data, apply filters, save configs, etc...
Table Management
API for managing tables, retrieve summaries and details, and handle item orders. Retrieve available table-zones, list tables by zone, add items to a cart, and manage cancellations efficiently.
Authentication & Security
Robust authentication system with role-based access control. Secure your API endpoints and protect sensitive business data.
Configuration Management
Flexible configuration system to customize your business rules and settings. Adapt the system to your specific business needs.
Microservices Architecture
Built on a scalable microservices architecture. Separate services for web client, API gateway, reporting, and core functionality ensure optimal performance.
About XD Soba API
The XD Soba API provides a robust interface for managing your business operations. Built with modern REST principles, it offers a secure, scalable, and developer-friendly way to integrate with the XD Soba platform.
Key Features
- Entity Management - Create and manage customers, suppliers, and other business entities
- Delivery Region Control - Define and manage delivery regions with precise boundaries
- Item & Group Management - Organize items into groups and manage them efficiently
- Report Management - Generate standard and dynamic reports with flexible parameters and export option
- Table Management - Manage tables and their respective zones efficiently
- Secure Authentication - JWT-based authentication with role-based access control
- Comprehensive Documentation - Detailed API reference with examples and guides
Getting Started
To begin using the XD Soba API, you'll need to:
- Obtain your API credentials from the XD Soba platform
- Review the Getting Started Guide
- Explore the API Reference
- Check out the API Usage Guide for best practices
API Capabilities
Entity Management
- Create and update customer profiles
- Manage supplier information
- Track entity relationships
- Handle entity status updates
Delivery Operations
- Define delivery regions
- Set delivery boundaries
- Manage delivery schedules
- Track delivery status
Item Management
- Create and update items
- Organize items into groups
- Manage item inventory
- Track item status
Security & Access
- JWT-based authentication
- Role-based access control
- API key management
- Secure data transmission
Table Management
- Manage tables, retrieve summaries and details, and handle item orders.
- Retrieve available table-zones
- List tables by zone
- Add items to a cart
- Manage cancellations efficiently
- Send the items from the trolley to the specific table.
Report Management
- View reports on sales, purchases, current accounts, etc., ensuring effective management and analysis of your business.
- Create dynamic custom reports
- Apply flexible filters and parameters
- Save custom configurations
- Export dynamic reports