Giter Club home page Giter Club logo

php-betaseries-api's Introduction

rtransat/betaseries-api

Ce paquet permet de gérer les différentes ressources que l'API de Betaseries fournit.

Sommaire

Pré-requis

  • Ce paquet requiert PHP 5.5+ et Guzzle 6.0+

Commencer

Installation

Ajoutez le paquet à votre composer.json et mettez à jour vos dépendances avec composer update:

"require": {
    ...
    "rtransat/betaseries-api": "^1.0.0",
},

Création du client

$betaseries = new \Betaseries\Betaseries('VOTRE_CLE_API', 'TOKEN_UTILISATEUR')
$client = new \Betaseries\Client($betaseries);

Pour récupérer le token utilisateur, ce wrapper ne permet pas (encore) de se connecter via OAuth2, Simili OAuth ou identification basique. Cependant vous pouvez utiliser le paquet suivant rtransat/oauth2-betaseries pour se connecter via OAuth2 et récupérer votre token. Il s'agit d'un provider pour le paquet oauth2 de thephpleague qui vous permettra de gérer la connexion OAuth2 de Betaseries.

Utilisation générale

// Affiche les informations d'une série. (Game of Thrones)
$show = $client->api('shows')->display(1161);

// Affiche les épisodes d'une série.
1161 => $id = ID de la série
1 => $season = Numéro de la saison
5 => $episode = Numéro de l'épisode
$subtitles = Affiche les sous-titres si renseigné (true ou false)
$showWithOnlyOneEpisode = $client->api('shows')->episodes(1161, 1, 5);

Documentation

Méthodes de l'api betaseries.

La liste des ressources actuellement prise en charge par php-betaseries-api sont :

Lorsque vous souhaitez utiliser une ressource en particulier il vous suffit de le définir dans la méthode api()

$client->api('shows')->display($id);

Concernant l'utilisation des paramètres de chaque méthode, il suffit de passer les paramètres par ordre ou Betaseries les utilisent. Vous pouvez voir ici les différents paramètres de ce wrapper.

L'API de Betaseries permet de faire une requête vers un identifiant, si on prend le cas de la méthode display pour la ressource shows, les paramètres sont les suivants :

  • id : ID de la série
  • thetvdb_id : ID de la série sur TheTVDB
  • imdb_id : ID de la série sur IMDB

Dans le cas de ce wrapper, seul l'id est utilisé. (Il s'agit de l'identifiant de Betaseries)

À noter que les méthodes de l'api "pictures" retourne actuellement un base64 de l'image.

Contribution

N'hésitez pas à soumettre une issue si vous trouvez un bug ou une idée d'amélioration. Les PR sont les bienvenues (Support du standard PSR-2).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.