API publique de Simple Roleplay

Cette page présente les routes publiques de l'API de Simple Roleplay

Préambule

⚠️ Seules les routes présentées peuvent être utilisées, vous risquez d'être sanctionné si vous utilisez des routes accessibles mais qui ne seraient pas documentées ici.

💾 Vous devez également utiliser l'API correctement et sans abus, si vous mettez par exemple en place un système qui doit récupérer des informations sur une grande liste de joueurs, prévoyez de segmenter votre requête et de la mettre en cache la réponse. Si votre utilisation de l'API impacte les performances de nos services vous serez restreints et encourrez des sanctions.

👉 Vous pouvez avoir un aperçu des réponses en cliquant sur le caractère > à droite des réponses possibles.

Routes publiques

Récupérer un joueur

GET https://api.simple-roleplay.fr/public/user.php

Permet d'obtenir les informations de base d'un joueur.

Query Parameters

Name	Type	Description
id*	String	Identifiant du joueur : peut être un DiscordID, un SteamID64 ou encore le nom RP complet du joueur.

200: OK Informations de base d'un joueur

Exemple

{
    "steamid64": "string",
    "name": "string",
    "isAdmin": boolean,
    "isSuperAdmin": boolean,
    "isPoliceChief": boolean,
    "discordId": "string"
}

Schéma de la réponse

400: Bad Request La requête était malformée

404: Not Found Le joueur spécifié n'est pas trouvé

Récupérer plusieurs joueurs

POST https://api.simple-roleplay.fr/public/user.php

Permet d'obtenir les informations de base de plusieurs joueurs en même temps.

Request Body

Name	Type	Description
players*	Array	Liste d'identifiants : SteamID64, DiscordID, nom RP complet du joueur

200: OK Informations de bases des joueurs

Exemple

[
...
    "id1": {
        "steamid64": "string",
        "name": "string",
        "isAdmin": boolean,
        "isSuperAdmin": boolean,
        "isPoliceChief": boolean,
        "discordId": "string"
    },
    "id2": {
        "steamid64": "string",
        "name": "string",
        "isAdmin": boolean,
        "isSuperAdmin": boolean,
        "isPoliceChief": boolean,
        "discordId": "string"
    },
...
]

Schéma de la réponse

400: Bad Request La requête était malformée

Exemple de requête

curl -X POST https://api.simple-roleplay.fr/public/user.php \
              -H 'Content-Type: application/json' \
              -d '{"players": ["Alexandre Troll", "Kilian Roux"]}'

Récupérer le classement des métiers

GET https://api.simple-roleplay.fr/public/leaderboard.php

Obtenez le classement des métiers.

💾 Le résultat de la requête est mis en cache automatiquement par nos services et est rafraîchi toutes les 2 heures.

200: OK Le classement des métiers global

Exemple

{
    citizen: {
        experience: [
            ...
            {
                "name": "string",
                "score": "string"
            },
            ...
        ],
        time_played: [
            ...
            {
                "name": "string",
                "score": "string"
            },
            ...
        ]
    },
    ...
}

Schéma de la réponse

Récupérer la liste des bannissements

GET https://api.simple-roleplay.fr/public/bans.php

Récupérer tous les joueurs bannis.

💾 Le résultat de la requête est mis en cache automatiquement par nos services et est rafraîchi toutes les 20 minutes.

200: OK La liste des bannissements

Exemple

[
    ...
    {
        "player": {
            "steamid64": "string",
            "name": "string"
        },
        "author": {
            "steamid64": "string",
            "name": "string"
        },
        "created_at": "string",
        "duration": "string",
        "reason": "string"
    },
    ...
]

Schéma de la réponse