Files
CDN-APP-INSIDER/views/doc_cdn-app_api.ejs
Dinawo f7658eca22
All checks were successful
continuous-integration/drone Build is passing
V1.0.0-beta.17 Update 2
2024-12-15 00:49:12 +01:00

266 lines
12 KiB
Plaintext

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Documentation API CDN-APP</title>
<style>
body {
font-family: 'Segoe UI', Tahoma, Geneva, Verdana, sans-serif;
margin: 0;
padding: 0;
background-color: #0F0F0F;
color: #F2F2F2;
}
.container {
max-width: 800px;
margin: 0 auto;
padding: 40px;
background-color: #1A1A1A;
border-radius: 12px;
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);
}
h1, h2, h3 {
color: #4D9EFF;
margin-bottom: 20px;
}
.endpoint {
margin-top: 40px;
padding: 30px;
background-color: #2C2C2C;
border-radius: 12px;
box-shadow: 0 4px 8px rgba(0, 0, 0, 0.1);
}
.endpoint-title {
font-size: 1.6em;
font-weight: bold;
margin-bottom: 15px;
}
.parameters, .responses {
margin-left: 30px;
}
.parameters ul, .responses ul {
list-style-type: none;
padding: 0;
}
.parameters li, .responses li {
margin-bottom: 10px;
}
.parameters li:before, .responses li:before {
content: "\2022";
color: #4D9EFF;
display: inline-block;
width: 1em;
margin-left: -1em;
}
.version-info {
font-size: 0.9em;
color: #8C8C8C;
margin-bottom: 30px;
}
</style>
</head>
<body>
<div class="container">
<h1>Documentation API CDN-APP</h1>
<div class="version-info">
<p><strong>URL de base</strong> : /api/dpanel/</p>
</div>
<h2>Présentation</h2>
<p>Cette documentation décrit l'API CDN-APP, qui permet aux utilisateurs de gérer les fichiers et les dossiers au sein de l'application CDN. Elle comprend des points de terminaison pour la création, la suppression, le déplacement et la récupération de fichiers et de dossiers. Toutes les requêtes nécessitent un jeton JWT valide dans l'en-tête d'autorisation.</p>
<h2>Points de terminaison</h2>
<h3>Dossier</h3>
<div class="endpoint">
<div class="endpoint-title">1. Obtenir les fichiers et dossiers d'un dossier spécifique</div>
<p><strong>Point de terminaison</strong> : POST /dashboard/getfilefolder/{folderName}?token={token}</p>
<p><strong>Description</strong> : Cette route vous permet d'obtenir les fichiers et les dossiers d'un dossier spécifique. Elle nécessite un jeton JWT valide dans l'en-tête d'autorisation.</p>
<div class="parameters">
<p><strong>Paramètres</strong> :</p>
<ul>
<li><strong>folderName</strong> (chemin) : Le nom du dossier</li>
<li><strong>Authorization</strong> (en-tête) : Le jeton JWT de votre compte pour avoir accès</li>
</ul>
</div>
<div class="responses">
<p><strong>Réponses</strong> :</p>
<ul>
<li><strong>200</strong> : Succès</li>
<li><strong>401</strong> : Non autorisé</li>
<li><strong>404</strong> : Le dossier spécifié n'existe pas</li>
<li><strong>500</strong> : Erreur interne du serveur</li>
</ul>
</div>
</div>
<div class="endpoint">
<div class="endpoint-title">2. Supprimer un dossier spécifique</div>
<p><strong>Point de terminaison</strong> : POST /dashboard/deletefolder/{folderName}?token={token}</p>
<p><strong>Description</strong> : Cette route vous permet de supprimer un dossier spécifique. Elle nécessite un jeton JWT valide dans l'en-tête d'autorisation.</p>
<div class="parameters">
<p><strong>Paramètres</strong> :</p>
<ul>
<li><strong>folderName</strong> (chemin) : Le nom du dossier</li>
<li><strong>Authorization</strong> (en-tête) : Le jeton JWT de votre compte pour avoir accès</li>
</ul>
</div>
<div class="responses">
<p><strong>Réponses</strong> :</p>
<ul>
<li><strong>200</strong> : Le dossier a été supprimé avec succès</li>
<li><strong>400</strong> : Mauvaise requête</li>
<li><strong>401</strong> : Non autorisé</li>
<li><strong>403</strong> : Vous n'avez pas la permission de supprimer ce dossier</li>
<li><strong>404</strong> : Le dossier spécifié n'existe pas</li>
<li><strong>500</strong> : Erreur lors de la suppression du dossier</li>
</ul>
</div>
</div>
<div class="endpoint">
<div class="endpoint-title">3. Créer un nouveau dossier</div>
<p><strong>Point de terminaison</strong> : POST /dashboard/newfolder?token={token}</p>
<p><strong>Description</strong> : Cette route vous permet de créer un nouveau dossier. Elle nécessite un jeton JWT valide dans l'en-tête d'autorisation.</p>
<div class="parameters">
<p><strong>Paramètres</strong> :</p>
<ul>
<li><strong>Authorization</strong> (en-tête) : Le jeton JWT de votre compte pour avoir accès</li>
</ul>
</div>
<div class="responses">
<p><strong>Réponses</strong> :</p>
<ul>
<li><strong>200</strong> : Succès</li>
<li><strong>400</strong> : Mauvaise requête</li>
<li><strong>401</strong> : Non autorisé</li>
<li><strong>500</strong> : Erreur lors de la création du dossier</li>
</ul>
</div>
</div>
<h3>Fichier</h3>
<div class="endpoint">
<div class="endpoint-title">1. Supprimer un fichier spécifique</div>
<p><strong>Point de terminaison</strong> : POST /dashboard/deletefile?token={token}</p>
<p><strong>Description</strong> : Cette route vous permet de supprimer un fichier spécifique. Elle nécessite un jeton JWT valide dans l'en-tête d'autorisation.</p>
<div class="parameters">
<p><strong>Paramètres</strong> :</p>
<ul>
<li><strong>Authorization</strong> (en-tête) : Le jeton JWT de votre compte pour avoir accès</li>
</ul>
</div>
<div class="responses">
<p><strong>Réponses</strong> :</p>
<ul>
<li><strong>200</strong> : Succès</li>
<li><strong>400</strong> : Mauvaise requête</li>
<li><strong>401</strong> : Non autorisé</li>
<li><strong>404</strong> : Le fichier spécifié n'existe pas</li>
<li><strong>500</strong> : Erreur interne du serveur</li>
</ul>
</div>
</div>
<div class="endpoint">
<div class="endpoint-title">2. Obtenir les informations d'un fichier</div>
<p><strong>Point de terminaison</strong> : POST /dashboard/getfile?token={token}</p>
<p><strong>Description</strong> : Cette route vous permet d'obtenir les informations sur un fichier spécifique. Elle nécessite un jeton JWT valide dans l'en-tête d'autorisation.</p>
<div class="parameters">
<p><strong>Paramètres</strong> :</p>
<ul>
<li><strong>Authorization</strong> (en-tête) : Le jeton JWT de votre compte pour avoir accès</li>
</ul>
</div>
<div class="responses">
<p><strong>Réponses</strong> :</p>
<ul>
<li><strong>200</strong> : Succès</li>
<li><strong>400</strong> : Mauvaise requête</li>
<li><strong>401</strong> : Non autorisé</li>
<li><strong>404</strong> : Le fichier spécifié n'existe pas ou aucune information n'a été trouvée pour le fichier</li>
<li><strong>500</strong> : Erreur lors de la lecture du fichier</li>
</ul>
</div>
</div>
<div class="endpoint">
<div class="endpoint-title">3. Déplacer un fichier vers un dossier différent</div>
<p><strong>Point de terminaison</strong> : POST /dashboard/movefile?token={token}</p>
<p><strong>Description</strong> : Cette route vous permet de déplacer un fichier vers un dossier différent. Elle nécessite un jeton JWT valide dans l'en-tête d'autorisation.</p>
<div class="parameters">
<p><strong>Paramètres</strong> :</p>
<ul>
<li><strong>Authorization</strong> (en-tête) : Le jeton JWT de votre compte pour avoir accès</li>
</ul>
</div>
<div class="responses">
<p><strong>Réponses</strong> :</p>
<ul>
<li><strong>200</strong> : Succès</li>
<li><strong>400</strong> : Mauvaise requête</li>
<li><strong>401</strong> : Non autorisé</li>
<li><strong>403</strong> : Tentative non autorisée d'accès à un répertoire</li>
<li><strong>500</strong> : Erreur lors du déplacement du fichier</li>
</ul>
</div>
</div>
<div class="endpoint">
<div class="endpoint-title">4. Renommer un fichier</div>
<p><strong>Point de terminaison</strong> : POST /dashboard/rename?token={token}</p>
<p><strong>Description</strong> : Cette route vous permet de renommer un fichier. Elle nécessite un jeton JWT valide dans l'en-tête d'autorisation.</p>
<div class="parameters">
<p><strong>Paramètres</strong> :</p>
<ul>
<li><strong>Authorization</strong> (en-tête) : Le jeton JWT de votre compte pour avoir accès</li>
</ul>
</div>
<div class="responses">
<p><strong>Réponses</strong> :</p>
<ul>
<li><strong>200</strong> : Succès</li>
<li><strong>400</strong> : Mauvaise requête</li>
<li><strong>401</strong> : Non autorisé</li>
<li><strong>500</strong> : Erreur lors du renommage du fichier</li>
</ul>
</div>
</div>
<div class="endpoint">
<div class="endpoint-title">5. Télécharger un fichier</div>
<p><strong>Point de terminaison</strong> : POST /dpanel/upload?token={token}</p>
<p><strong>Description</strong> : Cette route vous permet de télécharger un fichier. Elle nécessite un jeton JWT valide dans l'en-tête d'autorisation.</p>
<div class="parameters">
<p><strong>Paramètres</strong> :</p>
<ul>
<li><strong>Authorization</strong> (en-tête) : Le jeton JWT de votre compte pour avoir accès</li>
</ul>
</div>
<div class="responses">
<p><strong>Réponses</strong> :</p>
<ul>
<li><strong>200</strong> : Succès</li>
<li><strong>400</strong> : Mauvaise requête</li>
<li><strong>401</strong> : Non autorisé</li>
<li><strong>500</strong> : Erreur lors du téléchargement du fichier</li>
</ul>
</div>
</div>
</div>
</body>
</html>