← Retour à l'accueil
🚀
Introduction
L'API CFTune vous permet de créer, gérer et analyser des liens raccourcis programmatiquement.
Notre API RESTful est simple à utiliser et offre toutes les fonctionnalités nécessaires pour
intégrer CFTune dans vos applications.
🔗
URL de Base
Production: https://villageoisyt.online/api
Développement: http://localhost:3000/api
🔐
Authentification
L'API CFTune utilise un système d'authentification par clé API pour sécuriser les endpoints.
🔑
Clé API
Pour utiliser l'API, vous devez inclure votre clé API dans l'en-tête
X-API-Key
de vos requêtes :
X-API-Key: VOTRE_CLE_API
Comment obtenir une clé API :
1. Créez un compte utilisateur sur
villageoisyt.online
2. Connectez-vous à votre
dashboard utilisateur
3. Allez dans la section "Mes Clés API"
4. Créez une nouvelle clé API
5. Copiez et conservez votre clé en sécurité
Récupérer la liste de vos clés API
En-têtes requis :
Authorization
string
Bearer VOTRE_CLE_API
🌐
API Publique
Endpoints publics pour créer et gérer des liens raccourcis.
Créer un nouveau lien raccourci
Paramètres :
url
string
URL à raccourcir (requis)
Exemple de requête :
curl -X POST https://villageoisyt.online/api/shorten \
-H "Content-Type: application/json" \
-H "X-API-Key: VOTRE_CLE_API" \
-d '{"url": "https://example.com"}'
Réponses :
200 Succès
400 URL invalide
401 Clé API invalide
Obtenir les statistiques d'un lien raccourci
Paramètres d'URL :
shortCode
string
Code du lien raccourci
💡
Exemples d'Utilisation
Exemples pratiques d'utilisation de l'API CFTune.
JavaScript (Fetch API)
Créer un lien :
const response = await fetch('https://villageoisyt.online/api/shorten', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-Key': 'VOTRE_CLE_API'
},
body: JSON.stringify({
url: 'https://example.com'
})
});
const data = await response.json();
console.log(data.shortUrl); // https://villageoisyt.online/abc123
Python (requests)
Créer un lien :
import requests
response = requests.post('https://villageoisyt.online/api/shorten',
headers={'X-API-Key': 'VOTRE_CLE_API'},
json={'url': 'https://example.com'})
data = response.json()
print(data['shortUrl'])
cURL
Créer un lien :
curl -X POST https://villageoisyt.online/api/shorten \
-H "Content-Type: application/json" \
-H "X-API-Key: VOTRE_CLE_API" \
-d '{"url": "https://example.com"}'
⚡
Limites et Codes de Réponse
Informations importantes sur les limites de l'API et les codes de réponse.
Limites de l'API
• Limite de liens : 100 liens maximum par compte utilisateur
• Limite de requêtes : 100 requêtes par 15 minutes par clé API
• Longueur URL : Maximum 2048 caractères
• Format URL : Doit être une URL valide (http/https)
Codes de Réponse HTTP
200 Succès - Requête traitée avec succès
400 Erreur de requête - URL invalide ou paramètres manquants
401 Non autorisé - Clé API invalide ou manquante
403 Interdit - Limite de liens atteinte
404 Non trouvé - Lien raccourci inexistant
429 Trop de requêtes - Limite de taux dépassée
500 Erreur serveur - Problème interne du serveur