README.md

EN CONSTRUCTION !! Publication sur npm en fin d'année

FFTTApi, API Node.JS/TypeScript pour la FFTT

FFTTApi permet de consommer facilement l'API officielle de la Fédération Française de Tennis de table.

Installation avec Composer

Il est recommandé d'installer FFTTApi grâce à composer Composer.

# Installer Composer
curl -sS https://getcomposer.org/installer | php

Puis, lancez la commande composer pour installer la dernière version stable de FFTTApi :

php composer.phar require al37350/fftt-api

Après l'installation, vous devez requérir l'autoloader de composer :

require 'vendor/autoload.php';

Ainsi vous pouvez facilement mettre à jour le packet.

composer.phar update

Exemple d'utilisation

<?php

use FFTTApi\FFTTApi;

require __DIR__ . '/vendor/autoload.php';

$api = new FFTTApi("identifiant", "password");
$joueurs = $api->getJoueursByNom("Lamirault");

Fonctionnalités

• Liste des organismes
• Liste des clubs par département
• Liste des clubs par nom
• Détail d'un club
• Lists des joueurs d'un club
• Liste des joueurs par nom, prénom
• Détail d'un joueur
• Classement d'un joueur
• Historique d'un joueur
• Liste des parties d'un joueur
• Liste des parties non validées d'un joueur
• Points virtuels d'un joueur
• Liste des équipes d'un club
• Classement d'une poule
• Liste des rencontres d'une poule
• Liste des prochaines rencontres d'une équipe
• Détail d'une rencontre
• Liste des actualitées

Tests

Vous pouvez lancer les tests unitaires avec la commande suivante:

$ cd path/to/FFTTApi/
$ composer.phar install
$ cp tests/.env.dist tests/.env #Set your parameters
$ phpunit