BLAGUES API

Le module npm de Blagues-API développé en Typescript supporte l'intégralité des options présente sur l'API, il permettra d'intéragir simplement avec l'API depuis le langage NodeJs.

        
          <script src="https://unpkg.com/[email protected]/dist/blagues-api.umd.js"></script>
        
      

        
          import BlaguesAPI from 'blagues-api';
        
      

        
          const BlaguesAPI = require('blagues-api');
        
      

      
        const blagues = new BlaguesAPI('VOTRE_TOKEN_ICI');
      
    

Il est fortement conseillé d'utiliser les variables d'environnement avec dotenv afin de ne pas mettre votre token dans le code source de votre projet.

Différentes méthodes vous sont rendues disponibles afin d'intéragir plus facilement avec l'API depuis votre projet.

        
          const blague = await blagues.random();
        
      

        
          const blague = await blagues.random({
            disallow: [
              blagues.categories.DARK,
              blagues.categories.LIMIT
            ]
          });
        
      

        
          const blague = await blagues.randomCategorized(
            blagues.categories.DARK
          );
        
      

        
          const blague = await blagues.fromId(50);
        
      

        
          const blague = await blagues.count();
        
      

Le module PyPi de Blagues-API supporte l'intégralité des options présente sur l'API, il permettra d'intéragir simplement avec l'API depuis le langage Python de manière asynchrone.

      
        from blagues_api import BlaguesAPI
      
    

      
        blagues = BlaguesAPI("VOTRE_TOKEN_ICI")
      
    

Il est fortement conseillé d'utiliser les variables d'environnement avec dotenv afin de ne pas mettre votre token dans le code source de votre projet.

Différentes méthodes asynchrones vous sont rendues disponibles afin d'intéragir plus facilement avec l'API depuis votre projet.

        
          blague = await blagues.random()
        
      

        
          blague = await blagues.random(disallow=[BlagueType.LIMIT, BlagueType.BEAUF])
        
      

        
          blague = await blagues.random_categorized(BlagueType.DEV)
        
      

        
          blague = await blagues.from_id(50)
        
      

        
          blague = await blagues.count()
        
      

Le module Packagist de Blagues-API supporte l'intégralité des options présente sur l'API, il permettra d'intéragir simplement avec l'API depuis le langage PHP de manière synchrone.

      
        use BlaguesApi\BlaguesApi;
        use BlaguesApi\Model\Joke;
      
    

      
        $blaguesApi = BlaguesApi::create('VOTRE_TOKEN_ICI');
      
    

Il est fortement conseillé d'utiliser les variables d'environnement avec un package comme symfony/dotenv par exemple, afin de ne pas mettre votre token dans le code source de votre projet.

Différentes méthodes vous sont rendues disponibles afin d'intéragir plus facilement avec l'API depuis votre projet.

        
          $joke = $blaguesApi->getRandom();
        
      

        
          $joke = $blaguesApi->getRandom([Joke::TYPE_DARK]);
        
      

        
          $joke = $blaguesApi->getByType(Joke::TYPE_DEV);
        
      

        
          $joke = $blaguesApi->getById(1234);
        
      

        
          $joke = $blaguesApi->count();
        
      

L'API Rest est le meilleur moyen d'utiliser Blagues-API sans dépendances, en requièrera nénanmoins plus de connaissances et de prérequis.

Différentes routes vous sont rendues disponibles afin d'adapter l'api a votre projet. Les différents mots clés vous permettront de récupérer une blague aléatoirement dans un thème ou type de blague spécifique.

GET /api/random

GET /api/type/:type:/random // type: global, dev, dark, limit, beauf, blondes

GET /api/id/:id:

GET /api/count

Parfois certains types d'humour dérangent certaines personnes, hors blagues-api est une api publique qui s'est donné comme mission de convenir aux tous types d'humour. C'est pour cela que nous vous offrons la possibilité de filtrer les blagues et donc d'en retirer celles qui font partie d'une catégorie qui ne vous convient pas.

GET /api/random?disallow=dark

GET /api/random?disallow=dark&disallow=limit&disallow=dev

L'api de blagues utilise un token d'authentification Bearer pour les requêtes. Vous pouvez le gérer depuis votre profil.
Les requêtes doivent toutes être effectuées via HTTPS. Tous les appels effectuées sans authentification ou en HTTP échoueront.
Si vous avez des difficultées à obtenir un certificat HTTPS, voici Certbot, un outil qui permet d'en obtenir un gratuitement !

        curl https://www.blagues-api.fr/api/random \
          -H "Authorization: Bearer VOTRE_TOKEN_ICI" \

Voici un exemple sous forme de cas d'utilisation de l'api dans le cas où l'on souhaite récupérer une blague aléatoirement dans le répertoire toute catégorie confondue

      fetch('https://www.blagues-api.fr/api/random', {
        headers: {
          'Authorization': `Bearer VOTRE_TOKEN_ICI`
        }
      })
      .then(response => response.json())
      .then(data => {
        console.log(data)
        /* Expected output:
        {
          "id": 1,
          "type": "dev",
          "joke": "Un développeur ne descend pas du métro.",
          "answer": "Il libère la RAM..."
        }
        */
      })