Pokimac API - Documentation

Les 2 premières requêtes (celles qui n'ont pas de lien avec les scores) s'appuient sur l'api GraphQL publique PokéAPI.

Récupérer les créatures d'une génération

Requête

Méthode GET

https://pokimac-api.super-sympa.fr/generation/[ID_GENERATION]

Réponse

Champ	Type	Description
generation	string	Génération des créatures renvoyées
count	int	Nombre de créatures renvoyées
pokemons	array[Pokemon]	Liste des créatures, voir description d'un pokemon juste en dessous

Pokemon :

Champ	Type	Description
id	int	id unique de la créature
name	string	Nom en français de la créature
image	string	Lien vers l'image de la créature
types	array[Type]	Liste des types, voir description d'un type juste en dessous

Type :

Champ	Type	Description
name	string	Nom en français du type
image	string	URL de l'image du type (icone + nom en anglais)

Exemple :

Requête :

https://pokimac-api.super-sympa.fr/generation/1

Réponse :

{
  "generation": "1",
  "count": 151,
  "pokemons": [
    {
      "id": 1,
      "name": "Bulbizarre",
      "types": [
        {
          "name": "Plante",
          "image": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-viii/sword-shield/12.png"
        },
        {
          "name": "Poison",
          "image": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-viii/sword-shield/4.png"
        }
      ],
      "image": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/other/official-artwork/1.png"
    },
    {
      "id": 2,
      "name": "Herbizarre",
      "types": [
        {
          "name": "Plante",
          "image": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-viii/sword-shield/12.png"
        },
        {
          "name": "Poison",
          "image": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-viii/sword-shield/4.png"
        }
      ],
      "image": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/other/official-artwork/2.png"
    },
    ...
  ]
}

Récupérer des créatures aléatoires

Requête

Méthode GET

https://pokimac-api.super-sympa.fr/random

Paramètres :

Champ	Type	Description	Obligatoire ?
generation	int	Numéro de la génération visée (entre 1 et 9 inclus)	Oui
count	int	Nombre de créatures voulues	Oui

Réponse

Exactement pareil que la requête précédente

Exemple :

Requête :

https://pokimac-api.super-sympa.fr/random?generation=5&count=2

Réponse :

{
  "generation": "5",
  "count": 2,
  "pokemons": [
    {
      "id": 544,
      "name": "Scobolide",
      "types": [
        {
          "name": "Insecte",
          "image": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-viii/sword-shield/7.png"
        },
        {
          "name": "Poison",
          "image": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-viii/sword-shield/4.png"
        }
      ],
      "image": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/other/official-artwork/544.png"
    },
    {
      "id": 583,
      "name": "Sorboul",
      "types": [
        {
          "name": "Glace",
          "image": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/types/generation-viii/sword-shield/15.png"
        }
      ],
      "image": "https://raw.githubusercontent.com/PokeAPI/sprites/master/sprites/pokemon/other/official-artwork/583.png"
    }
  ]
}

Récupérer les scores

Requête

Méthode GET

https://pokimac-api.super-sympa.fr/scores

Paramètres :

Champ	Type	Description	Obligatoire ?
generation	int	Numéro de la génération visée (entre 1 et 9 inclus)	Oui

Réponse

Champ	Type	Description
scores	array[Score]	Liste des types, voir description d'un score juste en dessous

Score :

Champ	Type	Description
id	int	id unique du score
username	string	Nom d'utilisateur du joueur
score	int	Score
generation	int	Génération dans laquelle la partie a été jouée

Exemple :

Requête :

https://pokimac-api.super-sympa.fr/scores?generation=3

Réponse :

{
  "scores": [
    {
      "id": 1,
      "username": "Coco",
      "score": 10,
      "generation": 3
    },
    {
      "id": 2,
      "username": "Alex",
      "score": 20,
      "generation": 3
    },
    {
      "id": 3,
      "username": "Léna",
      "score": 2,
      "generation": 3
    }
  ]
}

Envoyer un score

Requête

Méthode POST

https://pokimac-api.super-sympa.fr/score

Body de la requête :

Champ	Type	Description	Obligatoire ?
generation	int	Numéro de la génération dans laquelle la partie a été jouée	Oui
username	string	Nom de la personne qui a joué	Oui
score	int	Score de fin de partie	Oui

Réponse

Champ	Type	Description
score	Score	Score, du même type que les scores dans la requête précédente

Exemple :

Requête :

https://pokimac-api.super-sympa.fr/scores?generation=3

Body :

{
  "username": "Coco",
  "score": 10,
  "generation": 3
}

Réponse :

{
  "score": {
    "id": 1,
    "username": "Coco",
    "score": 10,
    "generation": 3
  }
}