API Introduction

​

Welcome to Urban Things API

​

Key Features

• Multi-Tenant Architecture - Users can belong to multiple organizations
• Role-Based Access Control - ADMIN and MEMBER roles per tenant
• Team Member Management - Add, update, and remove team members
• Product & Category Management - Full CRUD operations
• Order Processing - Complete order management system
• Event-Driven - Webhook integrations and event publishing
• Secure Authentication - Laravel Sanctum token-based auth

​

Base URL

Production: https://faisalshop.mvp-apps.ae
Development: http://localhost:3000

​

Authentication

​

Getting a Token

POST /api/v2/admin/login
Content-Type: application/json

{
  "email": "user@example.com",
  "password": "your-password"
}

​

Using the Token

Authorization: Bearer {your-token}

​

Multi-Tenancy

X-Tenant-ID: 123

​

API Versioning

• v1: Public consumer-facing endpoints (/api/v1/...)
• v2: Admin and management endpoints (/api/v2/admin/...)

​

Rate Limiting

​

Response Format

​

Success Response

{
  "data": [...],
  "message": "Success message"
}

​

Error Response

{
  "error": "Error message"
}

​

Validation Error

{
  "message": "Validation failed",
  "errors": {
    "field_name": ["Error message"]
  }
}

​

Pagination

• page - Page number (default: 1)
• per_page - Items per page (default: 15)

{
  "data": [...],
  "current_page": 1,
  "per_page": 15,
  "total": 100,
  "last_page": 7
}

​

Common HTTP Status Codes

• 200 - Success
• 201 - Created
• 400 - Bad Request
• 401 - Unauthorized (missing or invalid token)
• 403 - Forbidden (insufficient permissions)
• 404 - Not Found
• 422 - Validation Error
• 429 - Too Many Requests
• 500 - Server Error

​

Need Help?

• Check the specific endpoint documentation for detailed examples
• Review the Architecture Guide for system design
• Contact support at info@faisalkc.com