API Développeur

Intégrez l'API du Jolly Rogenerator pour créer vos propres outils.

Aperçu de l'API

Les clés Bot couvrent les personnages, campagnes et équipages. Les clients mobiles first-party utilisent Firebase sur /api/app/v1/groups pour la sync versionnée des campagnes et équipages.

Documentation interactive

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

Ouvrir Swagger UI

Clé API

Les endpoints de l'API Bot 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.

Les routes App Groups sous /api/app/v1 utilisent Authorization: Bearer avec un jeton Firebase. Elles sont privées et hors CORS public.

Limites de débit

Les limites de débit 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 débit (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) sont inclus dans toutes les réponses.

Endpoints

Aperçu ci-dessous. Swagger liste la surface complète, y compris les schémas App Groups.

Personnages (Bot)

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

Campagnes (Bot)

GET/api/bot/campaigns

Lister les campagnes d'un utilisateur Discord

POST/api/bot/campaigns

Créer une campagne avec l'utilisateur comme MJ

GET/api/bot/campaigns/:id

Obtenir les détails, membres et personnages d'une campagne

POST/api/bot/campaigns/join/:inviteCode

Rejoindre une campagne avec un code d'invitation

POST/api/bot/campaigns/:id/characters

Assigner un personnage possédé à une campagne

GET/api/bot/campaigns/:id/members

Lister les membres d'une campagne

Équipages (Bot)

GET/api/bot/crews

Lister les équipages d'un utilisateur Discord

POST/api/bot/crews

Créer un équipage avec des permissions égales

GET/api/bot/crews/:id

Obtenir les détails, membres et personnages d'un équipage

POST/api/bot/crews/join/:inviteCode

Rejoindre un équipage avec un code d'invitation

GET/PATCH/api/bot/crews/:id/notes

Lire ou mettre à jour les notes partagées de l'équipage

POST/api/bot/crews/:id/leave

Quitter un équipage

App Groups (Firebase)

GET/api/app/v1/groups?type=…

Lister les campagnes ou équipages de l'utilisateur connecté

POST/api/app/v1/groups

Créer une campagne ou un équipage avec une enveloppe de mutation

POST/api/app/v1/groups/join

Rejoindre avec un code d'invitation et clientMutationId

GET/api/app/v1/groups/:id

Récupérer un instantané de groupe versionné

PATCH/api/app/v1/groups/:id

Mettre à jour les champs du groupe contre baseRevision

GET/api/app/v1/groups/:id/activity

Activité paginée par curseur pour un groupe

Voir la documentation complète des endpoints

Codes d'erreur

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

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 débit dépassée
`NOT_FOUND`	Ressource introuvable
`CHARACTER_NOT_FOUND`	Personnage introuvable
`ITEM_NOT_FOUND`	Objet introuvable
`CAMPAIGN_NOT_FOUND`	Campagne introuvable
`NOT_CAMPAIGN_MEMBER`	L'utilisateur n'est pas membre de la campagne
`CREW_NOT_FOUND`	Équipage introuvable
`NOT_CREW_MEMBER`	L'utilisateur n'est pas membre de l'équipage
`REVISION_CONFLICT`	baseRevision obsolète sur une écriture App Group
`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