
Documentation développeur
Développez, testez et dépannez plus rapidement.
Exemples de démarrage rapide, conseils d’authentification et étapes pratiques de dépannage pour les équipes intégrant les services IA de Ringed Horizon.
Démarrage rapide
Utilisez votre clé API Ringed Horizon avec l’en-tête Authorization pour chaque requête API protégée.
Authorization: Bearer YOUR_API_KEY
Sécurité : Traitez votre clé API comme un mot de passe. Ne la placez jamais dans des dépôts publics, captures d’écran, JavaScript côté navigateur ou tickets d’assistance.
Authentification
Si une requête retourne 401 Unauthorized, vérifiez les points suivants :
- L’en-tête Authorization est présent.
- La valeur commence par
Bearer. - La clé API ne contient pas d’espaces ou de caractères supplémentaires.
- La clé API n’a pas été révoquée ou remplacée.
Authorization: Bearer YOUR_API_KEY
Exemple de requête
Utilisez cette requête simple pour confirmer que l’authentification et la connectivité API fonctionnent.
curl https://api.ringedhorizon.com/v1/chat/completions \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d "{\"message\":\"Hello\"}"
Remarque : Le format exact des requêtes et les identifiants de modèles disponibles peuvent varier selon la version de l’API et les services activés.
Dépannage de la connectivité
1. Vérifier le DNS
nslookup api.ringedhorizon.com
Si la résolution DNS échoue, vérifiez votre connexion Internet, la configuration DNS, le VPN et les paramètres du réseau local.
2. Vérifier HTTPS et TLS
curl -Iv https://api.ringedhorizon.com
En cas d’erreur de certificat, vérifiez la date et l’heure du système ainsi que les certificats d’autorité de confiance du système d’exploitation.
3. Vérifier l’état de l’API
curl -I https://api.ringedhorizon.com/health
Si l’hôte est résolu mais que la connexion expire, vérifiez l’accès HTTPS sortant, les pare-feu, proxys, politiques VPN et logiciels de sécurité.
Erreurs API courantes
| Statut | Signification | Éléments à vérifier |
|---|---|---|
400 |
Requête incorrecte | Vérifiez la syntaxe JSON et les champs obligatoires. |
401 |
Non autorisé | Vérifiez la clé API et l’en-tête Bearer. |
403 |
Interdit | Vérifiez le compte, l’organisation, le forfait ou les autorisations. |
404 |
Introuvable | Vérifiez le nom d’hôte API, la version et le chemin du point de terminaison. |
429 |
Trop de requêtes | Réduisez la fréquence des requêtes et vérifiez les limites du forfait ou d’utilisation. |
500 |
Erreur serveur | Réessayez. Si le problème persiste, contactez l’assistance avec l’horodatage. |
502 |
Passerelle incorrecte | Réessayez après un court délai. Le service en amont peut être en cours de redémarrage. |
503 |
Service indisponible | Le service ou le modèle demandé peut être temporairement indisponible. |
Limites et utilisation
L’accès à l’API est soumis aux limites associées à votre forfait Ringed Horizon.
Une réponse 429 Too Many Requests peut indiquer que les requêtes sont envoyées trop rapidement ou qu’une limite d’utilisation applicable a été atteinte.
Vérifiez les détails de votre compte et de votre forfait avant de relancer des charges de travail importantes.
Avant de contacter l’assistance
Fournissez les informations suivantes afin que le problème puisse être examiné plus rapidement :
- Date et heure approximative du problème.
- Code d’état HTTP.
- Point de terminaison API appelé.
- Modèle demandé, le cas échéant.
- Système d’exploitation ou application utilisée.
- Message d’erreur pertinent.
- Indiquez si le problème est constant ou intermittent.
N’envoyez jamais votre clé API, mot de passe, code MFA, jeton d’accès ou autres identifiants à l’assistance.