XCloudEx API

API Documentation

Complete reference for XCloudEx API v3.0. Build scalable applications with our Firebase-like backend and advanced storage system.

API Categories

Choose the documentation you need

https://api.ulibtech.org

Database api

42 endpoints

Complete API reference for main endpoints

Features

AuthenticationProjectsCollectionsDocumentsUsersAnalytics

Quick Links

POST/api/auth/register
POST/api/projects
GET/api/projects/{id}/collections/{collectionId}/documents

Storage API

36 endpoints

Advanced file management with R2 storage

Features

File Upload/DownloadShare LinksVersioningTagsQuotasAnalytics

Quick Links

POST/api/storage/projects/{projectId}/upload
POST/api/storage/projects/{projectId}/shares
GET/api/storage/projects/{projectId}/quota

Webhooks

8 endpoints

Real-time event notifications

Features

Event SubscriptionsDelivery RetriesPayload ValidationSecurity

Quick Links

POST/api/webhooks
GET/api/webhooks

Getting Started

Quick Start

Get up and running in 5 minutes

Steps

  • 1
    Register an account
  • 2
    Create your first project
  • 3
    Generate an API key
  • 4
    Make your first API call

Example

curl -X POST 'https://api.ulibtech.org/api/auth/register' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "your@email.com",
    "password": "yourpassword",
    "displayName": "Your Name"
  }'

Authentication

Learn about authentication methods

Steps

  • 1
    Bearer token authentication
  • 2
    API key authentication
  • 3
    Session management
  • 4
    Rate limiting

Example

// With Bearer Token
Authorization: Bearer <your-jwt-token>

// With API Key
X-API-Key: <your-api-key>

Storage Setup

Start using the storage system

Steps

  • 1
    Create a project
  • 2
    Upload your first file
  • 3
    Share with share links
  • 4
    Set up quotas

Example

// Upload a file
const formData = new FormData();
formData.append('file', file);
formData.append('metadata', JSON.stringify({
  category: 'documents'
}));

fetch('https://api.ulibtech.org/api/storage/projects/{projectId}/upload', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer <token>'
  },
  body: formData
})

SDKs & Libraries

JavaScript/TypeScript

Official Node.js and browser SDK

Package@xcloudex/sdk

Python

Python SDK with async support

Packagexcloudex-python

React

React hooks and components

Package@xcloudex/react

Quick Reference

Base URL

https://api.ulibtech.org

Status

API Status
Live
Version3.0.0
Uptime99.9%

Support

Resources