Parcours › Jeux customs › API et webhooks

API et webhooks : branchez votre jeu au panel

Votre jeu envoie des événements au panel et reçoit des ordres en retour. Vous décidez quoi envoyer, quoi afficher et qui a le droit de quoi.

Les exemples de code sont illustratifs : les formats exacts se définissent avec votre projet.
Créer mon panelVoir le détail
EntréeWebhooks signés
SortieRequêtes vers votre jeu
DroitsPar clé
API et webhooks : branchez votre jeu au panel
Clés d'accès3 actives
Événements reçusExemple
Jeux
FiveMFiveMRedMRedMMinecraftMinecraftGTA VGTA San AndreasGarry's ModHytaleRobloxDayZHabboSCUMGTA 6 bientôtJeux customs
Technologies
{ }API REST↯WebhooksdbMySQLdbMariaDBdbPostgreSQL{}MongoDB · NoSQLdbRedis#Discord↗Game-rank.com⇄Pont de jeu

Ce que vous gérez · API et webhooks

Entrée

Des événements que vous nommez vous-même

Un événement a un nom, des champs et un destinataire dans le panel : profil du joueur, journal, site public ou Discord.

Modèle d'événement
custom.quest.doneplayer, quest, reward
Défini
player.joinplayer, server
Défini
{
  "event": "custom.quest.done",
  "player": "nolan_l",
  "quest": "livraison-port",
  "reward": 1500
}
Des événements que vous nommez vous-même
Sortie

Le panel peut aussi appeler votre jeu

Valider une candidature, sanctionner ou donner un grade peut déclencher une requête vers votre serveur.

Appels sortants
whitelist.acceptPOST /api/whitelist
Configuré
sanction.banPOST /api/ban
Configuré
POST /api/ban
{
  "player": "joueur_0877",
  "days": 7,
  "by": "Admin Marc"
}
Le panel peut aussi appeler votre jeu
Sécurité

Une clé par usage, révocable

Chaque intégration a sa clé, ses droits et son journal. Vous révoquez une clé sans toucher aux autres.

Clés
Serveur de productionLecture et écriture
Active
Site partenaireLecture seule
Active
Une clé par usage, révocable

Mise en place

En quatre étapes

01

Créez une clé

Avec ses droits.

02

Déclarez vos événements

Noms et champs.

03

Envoyez un test

Depuis votre serveur.

04

Branchez les écrans

Profil, journal, site.

Style

Dans le style de votre jeu

Exemples illustratifs : les formats exacts dépendent de votre jeu et de votre projet.

Exemples illustratifs : les formats exacts dépendent de votre jeu et de votre projet.

Autres sujets

API et webhooksAPI et webhooks SynchronisationSynchronisation de base Pont de jeuPont de jeu Rôles et modèleRôles, permissions et modèle de données propres à votre jeu← Jeux customsTous les sujets

Voir aussi

Intégrer un panel à son jeu : pont de jeu et APIDonnez un panel à chaque joueur : pont de jeu optionnel, API, synchron…Synchroniser une base MySQL ou PostgreSQL au panelReliez votre base de jeu au panel : correspondance des tables, lecture…Fonctionnalités du panel RPToutes les fonctionnalités : whitelist, sanctions, grades, jobs, sites…

FAQ

Questions fréquentes

Passez la souris sur une question.

01L'API est-elle documentée ?+

Une documentation est liée dans le pied de page ; le format exact est à valider avec vous.

02Quel langage côté jeu ?+

Tout langage qui sait envoyer une requête HTTP.

03Les événements sont-ils signés ?+

C'est l'objectif, à valider avant mise en production.

Passez à la mise en place.

Créer mon panelVoir tous les parcours

Gratuit pour démarrer.