Documentation API URLx

Intégrez le raccourcissement d'URL dans vos applications avec notre API REST. Simple, rapide et fiable.

Ouvrir la documentation Swagger Retour à l'accueil

Démarrage rapide

1 Créez un compte et connectez-vous
2 Générez votre token API dans votre tableau de bord
3 Utilisez le token dans l'en-tête Authorization pour toutes les requêtes

Fonctionnalités

Endpoints RESTful avec réponses JSON
Opérations CRUD complètes sur les URLs
Analytiques et statistiques en temps réel
Limitation de débit et pagination

Exemples de code

1. Créer une URL raccourcie

curl -X POST https://urlx.fr/api/url/create \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "long_url": "https://example.com/very/long/url"
  }'

2. Obtenir les statistiques d'une URL

curl -X GET https://urlx.fr/api/url/{slug}/stats \
  -H "Authorization: Bearer YOUR_TOKEN"

3. Lister toutes vos URLs

curl -X GET https://urlx.fr/api/url/list?page=1 \
  -H "Authorization: Bearer YOUR_TOKEN"

Authentification

Toutes les requêtes API nécessitent une authentification via des tokens Bearer. Incluez votre token dans l'en-tête Authorization de chaque requête.

Note : Vous pouvez générer votre token API depuis votre tableau de bord client dans la section API.

Limitation de débit et pagination

Pour garantir une utilisation équitable, l'API implémente une limitation de débit et une pagination :

requêtes/minute

éléments par page

∞

pages disponibles