API développeur

Intègre l'API du Jolly Rogenerator pour créer tes propres outils.

Aperçu de l'API

L'API du Jolly Rogenerator permet aux applications externes d'interagir avec vos personnages. Gérez les statistiques, l'inventaire et la progression de vos personnages par programmation.

Documentation interactive

Explorez la spécification complète de l'API avec notre interface Swagger interactive. Testez les endpoints, consultez les schémas de requêtes et réponses, et découvrez toutes les capacités de l'API.

Ouvrir Swagger UI

Clé API

Tous les endpoints de l'API nécessitent une authentification via l'en-tête X-Bot-API-Key.

# Exemple de requête

curl -H "X-Bot-API-Key: your-bot-api-key" \

"https://jollyrogenerator.com/api/bot/characters?discordId=123456789"

Contactez-nous pour obtenir une clé API pour votre intégration.

Limites de requêtes

Les limites de requêtes sont appliquées par clé API pour garantir une utilisation équitable et la stabilité du système.

Type d'opération	Limite
Lecture (GET)	100 requêtes/minute
Écriture (POST, PATCH, DELETE)	30 requêtes/minute

Les en-têtes de limite de requêtes (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) sont inclus dans toutes les réponses.

Points d'accès

L'API offre des capacités complètes de gestion des personnages :

GET/api/bot/characters

Lister tous les personnages d'un utilisateur Discord

GET/api/bot/characters/:id

Obtenir les détails complets d'un personnage, y compris les objets et les capacités

PATCH/api/bot/characters/:id

Mettre à jour les PV, la chance, l'argent ou les scores de caractéristiques

GET/api/bot/characters/:id/inventory

Obtenir l'inventaire du personnage classé par type

POST/api/bot/characters/:id/inventory

Ajouter un nouvel objet à l'inventaire du personnage

DELETE/api/bot/characters/:id/inventory/:itemId

Retirer un objet de l'inventaire du personnage

POST/api/bot/characters/:id/advance

Monter de niveau avec un jet de PV automatique

Voir la documentation complète des endpoints

Codes d'erreur

Toutes les erreurs renvoient une réponse JSON avec un code d'erreur pour faciliter le traitement.

Code	Description
`UNAUTHORIZED`	Authentification requise
`INVALID_API_KEY`	Clé API invalide fournie
`OWNERSHIP_DENIED`	L'utilisateur ne possède pas la ressource
`RATE_LIMITED`	Limite de requêtes dépassée
`NOT_FOUND`	Ressource introuvable
`CHARACTER_NOT_FOUND`	Personnage introuvable
`ITEM_NOT_FOUND`	Objet introuvable
`VALIDATION_ERROR`	Échec de la validation de la requête

Prêt à intégrer ? Explorez la documentation interactive de l'API ou contactez-nous pour obtenir votre clé API.

Ouvrir Swagger UI Rejoindre Discord