MediaGrade SFTP Server API (1.0.0)

Tous les endpoints (sauf /health) nécessitent une authentification via clé API. Deux méthodes sont supportées :

• Header X-API-Key : X-API-Key: your-api-secret-key
• Header Authorization : Authorization: Bearer your-api-secret-key

Les limites de taux suivantes s'appliquent par clé API :

• Requêtes générales : 100 requêtes par minute
• Uploads de fichiers : 10 requêtes par minute
• Téléchargements : 50 requêtes par minute

En cas de dépassement, une réponse 429 Too Many Requests est retournée avec les headers suivants :

• X-RateLimit-Limit : Limite totale
• X-RateLimit-Remaining : Requêtes restantes
• X-RateLimit-Reset : Timestamp de réinitialisation

Les endpoints retournant des listes supportent la pagination via les paramètres de requête :

• limit : Nombre d'éléments par page (défaut: 50, max: 1000)
• offset : Nombre d'éléments à ignorer (défaut: 0)

La réponse inclut un objet pagination avec :

• total : Nombre total d'éléments
• limit : Limite utilisée
• offset : Offset utilisé
• returned : Nombre d'éléments retournés dans cette page

Les paramètres de requête contenant des caractères spéciaux (accents, apostrophes, espaces) doivent être encodés en URL :

• Exemple : path=files/Capture d'écran.png → path=files%2FCapture%20d%27%C3%A9cran.png
• Décodage automatique : L'API décode automatiquement les paramètres encodés
• Normalisation Unicode : Tous les chemins sont normalisés en NFC (Normalization Form Composed) pour garantir la cohérence cross-platform

Important : macOS utilise NFD (Normalization Form Decomposed) par défaut, mais l'API normalise systématiquement en NFC pour garantir la cohérence avec Linux et Windows.

En cas d'erreur temporaire (codes 5xx, 429), il est recommandé d'implémenter une stratégie de retry avec backoff exponentiel :

• Tentatives : Maximum 3 tentatives
• Délai initial : 1 seconde
• Backoff : Multiplier par 2 à chaque tentative (1s, 2s, 4s)
• Codes à retry : 429, 500, 502, 503, 504

Ne pas retry sur les codes 4xx (sauf 429) car ce sont des erreurs client.

async function retryRequest(fn, maxRetries = 3) {
  for (let i = 0; i < maxRetries; i++) {
    try {
      return await fn();
    } catch (error) {
      if (i === maxRetries - 1) throw error;
      if ([429, 500, 502, 503, 504].includes(error.status)) {
        await new Promise(resolve => setTimeout(resolve, Math.pow(2, i) * 1000));
        continue;
      }
      throw error;
    }
  }
}

Vérification de l'état du serveur

Gestion des comptes SFTP

Gestion des fichiers et répertoires

Gestion des quotas de stockage

Synchronisation des fichiers

Informations système et statistiques