Module de configuration du site
Description de la fonction
Le préfixe de l'API unifiée est http(s)://<your-domain>
HTTPS doit être utilisé dans les environnements de production pour sécuriser les jetons d'authentification. HTTP n'est recommandé que pour les environnements de développement.
Il s'agit de la gestion de configuration système de plus haut niveau, accessible uniquement aux utilisateurs root. Il comprend des fonctionnalités telles que la configuration des paramètres globaux, la réinitialisation du rapport du modèle et la migration des paramètres de la console. Les mises à jour de configuration impliquent une logique stricte de validation des dépendances.
🔐 Authentification racine
Récupérer la configuration globale
- Nom de l'interface: récupérer la configuration globale
- Méthode HTTP: GET
- Chemin:
/api/option/ - Exigence d'authentification: racine
- Résumé des fonctions: récupère toutes les options de configuration globales du système, en filtrant les informations sensibles telles que les jetons, les secrets et les clés. 💡 Exemple de demande:
const response = await fetch('/api/option/', {
method: 'GET',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer your_root_token',
'New-Api-User': 'your_user_id'
}
});
const data = await response.json();✅ Exemple de réponse réussie:
{
"success": true,
"message": "",
"data": [
{
"key": "SystemName",
"value": "88API"
},
{
"key": "DisplayInCurrencyEnabled",
"value": "true"
},
{
"key": "QuotaPerUnit",
"value": "500000"
}
]
}❗ Exemple de réponse en cas d'échec:
{
"success": false,
"message": "Failed to retrieve configuration"
}🧾 Description du champ:
data (Array): Liste des éléments de configuration option.go: 15-18
key(String): nom de la clé de l'élément de configurationvalue(String) : valeur de l'élément de configuration ; les informations sensibles ont été filtrées option.go: 22-24
Mettre à jour la configuration globale
- Nom de l'interface: Mettre à jour la configuration globale
- Méthode HTTP: PUT
- Chemin:
/api/option/ - Exigence d'authentification: racine
- Résumé des fonctions: met à jour un seul élément de configuration globale, y compris la validation de la configuration et les contrôles de dépendance.
💡 Exemple de demande:
const response = await fetch('/api/option/', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer your_root_token',
'New-Api-User': 'your_user_id'
},
body: JSON.stringify({
key: "SystemName",
value: "My 88API System"
})
});
const data = await response.json();✅ Exemple de réponse réussie:
{
"success": true,
"message": "Configuration updated successfully"
}❗ Exemple de réponse en cas d'échec:
{
"success": false,
"message": "Cannot enable GitHub OAuth. Please fill in the GitHub Client Id and GitHub Client Secret first!"
}🧾 Description du champ:
key(String): nom de la clé de l'élément de configuration, option.go requise: 39-42value(Tout type): valeur de l'élément de configuration, prenant en charge les options booléennes, numériques, chaînes et autres types.go: 54-63
Réinitialiser les ratios du modèle
- Nom de l'interface: réinitialiser les ratios du modèle
- Méthode HTTP: POST
- Chemin:
/api/option/rest_model_ratio - Exigence d'authentification: racine
- Résumé des fonctions: réinitialise la configuration des ratios de tous les modèles à leurs valeurs par défaut, utilisées pour la réinitialisation groupée des prix des modèles.
💡 Exemple de demande:
const response = await fetch('/api/option/rest_model_ratio', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer your_root_token',
'New-Api-User': 'your_user_id'
}
});
const data = await response.json();✅ Exemple de réponse réussie:
{
"success": true,
"message": "Model ratios reset successfully"
}❗ Exemple de réponse en cas d'échec:
{
"success": false,
"message": "Failed to reset model ratios"
}🧾 Description du champ:
Aucun paramètre de requête. L'exécution réinitialisera toutes les configurations de ratio de modèle.
Migrer les paramètres de la console héritée
- Nom de l'interface: migrer les paramètres de la console héritée
- Méthode HTTP: POST
- Chemin:
/api/option/migrate_console_setting - Exigence d'authentification: racine
- Résumé des fonctions: migre les paramètres de la console de l'ancienne version vers le nouveau format de configuration, y compris les informations sur l'API, les annonces, la FAQ, etc.
💡 Exemple de demande:
const response = await fetch('/api/option/migrate_console_setting', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer your_root_token',
'New-Api-User': 'your_user_id'
}
});
const data = await response.json();✅ Exemple de réponse réussie:
{
"success": true,
"message": "migrated"
}❗ Exemple de réponse en cas d'échec:
{
"success": false,
"message": "Migration failed"
}🧾 Description du champ:
- Aucun paramètre de requête
- Le contenu de la migration comprend:
ApiInfo→console_setting.api_infoAnnouncements→console_setting.announcementsFAQ→console_setting.faqUptimeKumaUrl/UptimeKumaSlug→console_setting.uptime_kuma_groups