UDCShare API Documentation

> Intégrez le transfert de fichiers sécurisé dans vos applications avec notre API REST professionnelle

📋 Table des matières

Introduction
Authentification
Endpoints
Cas d'usage réels
Projets exemples
Limites par plan
Bonnes pratiques
Support

Introduction

L'API UDCShare permet aux développeurs d'intégrer des fonctionnalités de transfert de fichiers sécurisé dans n'importe quelle application. Notre API est conçue pour être simple, fiable et évolutive.

Caractéristiques principales

✅ Authentification par clé API sécurisée
✅ Support de tous les formats de fichiers
✅ Limites évoluives selon les plans
✅ Monitoring et statistiques intégrés
✅ Gestion des erreurs robuste
✅ Performance optimisée

Base URL

https://udcshare.com/api/v1

Authentification

Toutes les requêtes API doivent inclure une clé API dans le header X-API-Key.

X-API-Key: udc_your_api_key_here

Obtenir une clé API

Connectez-vous à votre dashboard UDCShare
Allez dans la section "Paramètres" → "Clés API"
Cliquez sur "+ Générer une clé"
Donnez un nom à votre clé (ex: "Mon Application Production")
Copiez la clé et conservez-la en sécurité

⚠️ Important: Les clés API ne sont affichées qu'une seule fois lors de la génération.

Plans requis

L'API REST est accessible uniquement avec un plan payant :

Essentials : 100 req/min, 5GB/fichier, 50 fichiers/jour
Pro : 300 req/min, 25GB/fichier, 200 fichiers/jour
Business : 1000 req/min, 1TB/fichier, 1000 fichiers/jour

Endpoints

1. Obtenir les informations du compte

Endpoint: GET /api/v1/account

Récupère les informations du compte et les limites de votre plan.

Requête:

curl -X GET https://udcshare.com/api/v1/account \
  -H "X-API-Key: udc_your_api_key_here"

Réponse:

{
  "id": "14a3c3c4-1330-4f0f-8aad-cdc7ff6e193c",
  "email": "user@example.com",
  "full_name": "John Doe",
  "plan": "pro",
  "premium": true,
  "subscription": {
    "plan": "pro",
    "is_premium": true,
    "activated_at": "2024-01-01T00:00:00Z",
    "expires_at": "2024-02-01T00:00:00Z",
    "days_remaining": 15,
    "is_expired": false
  },
  "api_limits": {
    "max_upload": 26843545600,
    "max_files_per_day": 200,
    "api_rate_limit": 300
  },
  "created_at": "2024-01-01T00:00:00Z"
}

2. Uploader un fichier

Endpoint: POST /api/v1/upload

Upload un fichier sur le serveur UDCShare.

Requête:

curl -X POST https://udcshare.com/api/v1/upload \
  -H "X-API-Key: udc_your_api_key_here" \
  -F "file=@document.pdf"

Réponse:

{
  "file_id": "81b6752b-fcc0-445a-939a-734dbff77d3a",
  "filename": "document.pdf",
  "filesize": 8692,
  "file_url": "https://udcshare.com/d/81b6752b-fcc0-445a-939a-734dbff77d3a",
  "created_at": "2024-01-01T00:00:00Z",
  "plan": "pro",
  "remaining_daily_uploads": 199
}

Limites:

Taille maximale selon votre plan (jusqu'à 1TB pour Business)
Limite quotidienne de fichiers selon votre plan
Tous les formats de fichiers supportés

3. Lister les fichiers

Endpoint: GET /api/v1/files

Récupère la liste des fichiers uploadés par l'utilisateur.

Requête:

curl -X GET https://udcshare.com/api/v1/files \
  -H "X-API-Key: udc_your_api_key_here"

Réponse:

{
  "files": [
    {
      "id": "81b6752b-fcc0-445a-939a-734dbff77d3a",
      "filename": "document.pdf",
      "filesize": 8692,
      "mime_type": "application/pdf",
      "status": "active",
      "created_at": "2024-01-01T00:00:00Z",
      "file_url": "https://udcshare.com/d/81b6752b-fcc0-445a-939a-734dbff77d3a"
    }
  ],
  "total": 1
}

4. Supprimer un fichier

Endpoint: DELETE /api/v1/files/:id

Supprime un fichier spécifique.

Requête:

curl -X DELETE https://udcshare.com/api/v1/files/81b6752b-fcc0-445a-939a-734dbff77d3a \
  -H "X-API-Key: udc_your_api_key_here"

Réponse:

{
  "success": true,
  "message": "Fichier supprimé"
}

5. Obtenir les statistiques

Endpoint: GET /api/v1/stats

Récupère les statistiques d'utilisation du compte.

Requête:

curl -X GET https://udcshare.com/api/v1/stats \
  -H "X-API-Key: udc_your_api_key_here"

Réponse:

{
  "total_files": 25,
  "total_storage_bytes": 5368709120,
  "total_storage_gb": 5.0,
  "account_created": "2024-01-01T00:00:00Z"
}

Cas d'usage réels

🏢 Backup automatisé pour entreprise

Automatisez les sauvegardes de vos documents importants vers UDCShare.

Scénario: Une entreprise veut sauvegarder automatiquement ses factures et contrats chaque nuit.

Solution: Utilisez l'API pour uploader les fichiers depuis votre système de gestion documentaire vers UDCShare avec un système de retry intelligent.

📱 Application mobile de partage

Permettez aux utilisateurs de votre application mobile de partager des fichiers via UDCShare.

Scénario: Une application de collaboration mobile permet aux utilisateurs d'envoyer des photos et documents.

Solution: Intégrez l'API dans votre backend mobile pour gérer les uploads de fichiers.

🎓 Plateforme éducative

Les enseignants peuvent distribuer des cours et devoirs aux étudiants via UDCShare.

Scénario: Une plateforme LMS veut permettre aux professeurs d'uploader des PDF de cours.

Solution: Utilisez l'API pour uploader les fichiers de cours et générer des liens de partage.

💼 Système de gestion de documents

Centralisez la gestion de documents pour votre équipe avec traçabilité complète.

Scénario: Une PME veut un système pour partager des documents entre collaborateurs.

Solution: Créez une interface custom qui utilise l'API en backend pour le stockage des fichiers.

Projets exemples

🐍 Python : Système de Backup Automatisé

Un système complet de backup avec logique de retry, monitoring et base de données personnalisée (SQLite). Stack: Python + SQLite + UDCShare API + Logging avancé 📁 Voir le projet Python complet

🟢 Node.js : API de Upload pour Application Web

API REST middleware pour gérer les uploads via UDCShare : authentification JWT, rate‑limiting, stockage MongoDB, webhooks et support d’upload streaming. Stack: Node.js + Express + MongoDB + UDCShare API + Rate Limiting 📁 Voir le projet Node.js complet

💻 JavaScript : Client Frontend

Client JavaScript vanilla qui encapsule les appels API : gestion du FormData, erreurs, et suivi de progression. Stack: Vanilla JS + FormData + Error Handling + Progress Tracking 📁 Voir le projet JavaScript complet

🟣 Ruby : Gem d'Upload

Gem Ruby professionnel pour intégrer l’API UDCShare dans Rails / Ruby : upload simple, multi‑fichiers, background jobs, et monitoring. Stack: Ruby + Rails + UDCShare API + Rate Limiting 📁 Voir le projet Ruby complet

🟢 Vue : Composant d’Upload

Composant Vue 3 moderne (Composition API) permettant drag‑&‑drop, upload multiple, thèmes et hooks personnalisés. Stack: Vue 3 + Composition API + UDCShare API 📁 Voir le projet Vue complet

🟡 React : Composant d’Upload

Composant React/Next.js avec hook useUDCShareUpload, prise en charge du drag‑&‑drop, upload multiple et callbacks personnalisés. Stack: React + Hooks + UDCShare API 📁 Voir le projet React complet

🟠 Angular : Module d’Upload

Module Angular/TypeScript offrant une UI configurable (thèmes, labels), intégration facile dans les projets Angular. Stack: Angular + TypeScript + UDCShare API 📁 Voir le projet Angular complet

🟦 Go : Service de Backup

Service Go qui communique avec l’API UDCShare : client HTTP, gestion d’erreurs, métriques et possibilité de déploiement en serveur ou serverless. Stack: Go + HTTP client + UDCShare API 📁 Voir le projet Go complet

🟦 PHP : Service d’Upload

Package PHP (Composer) pour uploader des fichiers via l’API UDCShare : support de multi‑uploads, callbacks et gestion d’erreurs. Stack: PHP + Composer + UDCShare API 📁 Voir le projet PHP complet

Limites par plan

Plan Essentials

Paramètre

Limite

-----------

--------

Rate Limiting

100 requêtes/minute

Taille max fichier

5GB

Fichiers par jour

50 fichiers

Types de fichiers

Tous

Plan Pro

Paramètre

Limite

-----------

--------

Rate Limiting

300 requêtes/minute

Taille max fichier

25GB

Fichiers par jour

200 fichiers

Types de fichiers

Tous

Plan Business

Paramètre

Limite

-----------

--------

Rate Limiting

1000 requêtes/minute

Taille max fichier

1TB

Fichiers par jour

1000 fichiers

Types de fichiers

Tous

Note: Les limites sont appliquées automatiquement par l'API. En cas de dépassement, vous recevrez une erreur HTTP 429 (Too Many Requests).

Codes d'erreur

Code HTTP

Description

Action

-----------

-------------

--------

200

Succès

400

Requête invalide

Vérifiez les paramètres

401

Non authentifié

Vérifiez votre clé API

403

Accès refusé

Vérifiez votre plan

404

Ressource non trouvée

Vérifiez l'ID du fichier

413

Fichier trop grand

Réduisez la taille du fichier

429

Trop de requêtes

Attendez ou upgradez votre plan

500

Erreur serveur

Réessayez ou contactez le support

Format d'erreur standard:

{
  "error": "Message d'erreur descriptif"
}

Bonnes pratiques

1. Gestion des erreurs

Implémentez toujours une gestion d'erreurs robuste avec retry logic pour les requêtes réseau.

2. Monitoring

Surveillez votre utilisation de l'API via l'endpoint /stats pour éviter les surprises.

3. Sécurité

Ne communiquez jamais vos clés API
Utilisez des variables d'environnement
Implémentez des rate limits côté client
Validez les fichiers avant upload

4. Performance

Utilisez le streaming pour les gros fichiers
Implementez le parallel processing pour les uploads multiples
Cachez les réponses quand c'est possible

Support

Pour toute question ou problème avec l'API :

📧 Email: support@udcshare.com
📚 Documentation: https://udcshare.com/api
🐛 Issues: Signalez via votre dashboard UDCShare
💬 Discord: Rejoignez notre communauté développeurs

Changelog

v1.0.0 (2024-06-06)

🎉 Version initiale de l'API REST
✅ Endpoints de base (account, upload, files, delete, stats)
✅ Authentification par clé API
✅ Limites selon les plans
✅ Support multipart/form-data

Dernière mise à jour: 6 Juin 2026 Version de l'API: v1

📚 Documentation API REST

UDCShare API Documentation

📋 Table des matières

Introduction

Caractéristiques principales

Base URL

Authentification

Obtenir une clé API

Plans requis

Endpoints

1. Obtenir les informations du compte

2. Uploader un fichier

3. Lister les fichiers

4. Supprimer un fichier

5. Obtenir les statistiques

Cas d'usage réels

🏢 Backup automatisé pour entreprise

📱 Application mobile de partage

🎓 Plateforme éducative

💼 Système de gestion de documents

Projets exemples

🐍 Python : Système de Backup Automatisé

🟢 Node.js : API de Upload pour Application Web

💻 JavaScript : Client Frontend

🟣 Ruby : Gem d'Upload

🟢 Vue : Composant d’Upload

🟡 React : Composant d’Upload

🟠 Angular : Module d’Upload

🟦 Go : Service de Backup

🟦 PHP : Service d’Upload

Limites par plan

Plan Essentials

Plan Pro

Plan Business

Codes d'erreur

Bonnes pratiques

1. Gestion des erreurs

2. Monitoring

3. Sécurité

4. Performance

Support

Changelog

v1.0.0 (2024-06-06)