> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Documentation de l'API Short URL

> Short link generation 集成指南 - XHuoAPI

Cet article présentera une documentation de l'API Short URL, qui peut convertir des URL longues en URL courtes.

## Processus de demande

Pour utiliser l'API, vous devez d'abord vous rendre sur la page correspondante de [Short URL API](https://api.xhuoapi.ai/documents/a2303356-6672-4eb8-9778-75f55c998fe9) pour demander le service correspondant. Une fois sur la page, cliquez sur le bouton « Acquire », comme indiqué sur l'image :

![](https://cdn.xhuoapi.ai/q6ytrc.png)

Si vous n'êtes pas encore connecté ou inscrit, vous serez automatiquement redirigé vers la page de connexion pour vous inviter à vous inscrire et à vous connecter. Après vous être connecté ou inscrit, vous serez automatiquement renvoyé à la page actuelle.

Lors de la première demande, un quota gratuit sera offert, vous permettant d'utiliser l'API gratuitement.

## Utilisation de base

Tout d'abord, comprenons la méthode d'utilisation de base, qui consiste à entrer l'URL longue à convertir pour obtenir le résultat traité. Vous devez d'abord transmettre un champ `content`. Nous pouvons ensuite remplir le contenu correspondant sur l'interface, comme indiqué sur l'image :

<p>
  <img src="https://cdn.xhuoapi.ai/4ascb2.png" width="500" className="m-auto" />
</p>

Nous pouvons voir que nous avons défini les en-têtes de requête, y compris :

* `accept` : le format de réponse souhaité, ici rempli avec `application/json`, c'est-à-dire au format JSON.
* `authorization` : la clé d'API pour appeler l'API, que vous pouvez sélectionner directement après la demande.

De plus, nous avons défini le corps de la requête, y compris :

* `content` : le contenu de l'URL à raccourcir.

Après avoir fait votre sélection, vous pouvez constater que le code correspondant a également été généré à droite, comme indiqué sur l'image :

<p>
  <img src="https://cdn.xhuoapi.ai/r3uakb.png" width="500" className="m-auto" />
</p>

Cliquez sur le bouton « Try » pour effectuer un test, comme indiqué sur l'image ci-dessus, et nous avons obtenu le résultat suivant :

```json theme={null}
{
  "success": true,
  "data": {
    "url": "https://surl.id/1uHCs01xa5"
  }
}
```

Le résultat de retour contient plusieurs champs, décrits comme suit :

* `success`, l'état de réussite de la tâche ici.
* `data`, qui contient l'URL convertie.

On peut voir que l'URL longue d'origine `https://api.xhuoapi.ai/documents/a2303356-6672-4eb8-9778-75f55c998fe9` a été convertie avec succès en URL courte `https://surl.id/1uHCs01xa5`.

De plus, si vous souhaitez générer le code d'intégration correspondant, vous pouvez le copier directement, par exemple, le code CURL est le suivant :

```shell theme={null}
curl -X POST 'https://api.xhuoapi.ai/v1/shorturl' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "content": "https://api.xhuoapi.ai/documents/a2303356-6672-4eb8-9778-75f55c998fe9"
}'
```

Le code d'intégration Python est le suivant :

```python theme={null}
import requests

url = "https://api.xhuoapi.ai/v1/shorturl"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "content": "https://api.xhuoapi.ai/documents/a2303356-6672-4eb8-9778-75f55c998fe9"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
```

## Gestion des erreurs

Lors de l'appel de l'API, si une erreur se produit, l'API renverra le code d'erreur et les informations correspondantes. Par exemple :

* `400 token_mismatched` : Mauvaise requête, probablement en raison de paramètres manquants ou invalides.
* `400 api_not_implemented` : Mauvaise requête, probablement en raison de paramètres manquants ou invalides.
* `401 invalid_token` : Non autorisé, jeton d'autorisation invalide ou manquant.
* `429 too_many_requests` : Trop de requêtes, vous avez dépassé la limite de taux.
* `500 api_error` : Erreur interne du serveur, quelque chose s'est mal passé sur le serveur.

### Exemple de réponse d'erreur

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## Conclusion

Grâce à ce document, vous avez compris comment utiliser l'API Short URL pour convertir des URL longues en URL courtes. Nous espérons que ce document vous aidera à mieux intégrer et utiliser cette API. Si vous avez des questions, n'hésitez pas à contacter notre équipe de support technique.